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 static void int_err_del(void)
 338         {
 339         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 340         if(int_error_hash_set)
 341                 {
 342                 lh_free(int_error_hash);
 343                 int_error_hash = NULL;
 344                 int_error_hash_set = 0;
 345                 }
 346         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 347         }
 348 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
 349         {
 350         ERR_STRING_DATA *p;
 351         LHASH *hash;
 352         err_fns_check();
 353         hash = ERRFN(err_get)();
 354         if(!hash)
 355                 return NULL;
 356         CRYPTO_r_lock(CRYPTO_LOCK_ERR);
 357         p = (ERR_STRING_DATA *)lh_retrieve(hash, d);
 358         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 359         return p;
 360         }
 361 static ERR_STRING_DATA *int_err_set_item(ERR_STRING_DATA *d)
 362         {
 363         ERR_STRING_DATA *p;
 364         LHASH *hash;
 365         err_fns_check();
 366         hash = ERRFN(err_get)();
 367         if(!hash)
 368                 return NULL;
 369         CRYPTO_r_lock(CRYPTO_LOCK_ERR);
 370         p = (ERR_STRING_DATA *)lh_insert(hash, d);
 371         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 372         return p;
 373         }
 374 static ERR_STRING_DATA *int_err_del_item(ERR_STRING_DATA *d)
 375         {
 376         ERR_STRING_DATA *p;
 377         LHASH *hash;
 378         err_fns_check();
 379         hash = ERRFN(err_get)();
 380         if(!hash)
 381                 return NULL;
 382         CRYPTO_r_lock(CRYPTO_LOCK_ERR);
 383         p = (ERR_STRING_DATA *)lh_delete(hash, d);
 384         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 385         return p;
 386         }
 387 static LHASH *int_thread_get(void)
 388         {
 389         LHASH *toret = NULL;
 390         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 391         if(!int_thread_hash_set)
 392                 int_thread_hash = lh_new(pid_hash, pid_cmp);
 393         if(int_thread_hash)
 394                 {
 395                 int_thread_hash_set = 1;
 396                 toret = int_thread_hash;
 397                 }
 398         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 399         return(toret);
 400         }
 401 static ERR_STATE *int_thread_get_item(const ERR_STATE *d)
 402         {
 403         ERR_STATE *p;
 404         LHASH *hash;
 405         err_fns_check();
 406         hash = ERRFN(thread_get)();
 407         if(!hash)
 408                 return NULL;
 409         CRYPTO_r_lock(CRYPTO_LOCK_ERR);
 410         p = (ERR_STATE *)lh_retrieve(hash, d);
 411         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 412         return p;
 413         }
 414 static ERR_STATE *int_thread_set_item(ERR_STATE *d)
 415         {
 416         ERR_STATE *p;
 417         LHASH *hash;
 418         err_fns_check();
 419         hash = ERRFN(thread_get)();
 420         if(!hash)
 421                 return NULL;
 422         CRYPTO_r_lock(CRYPTO_LOCK_ERR);
 423         p = (ERR_STATE *)lh_insert(hash, d);
 424         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 425         return p;
 426         }
 427 static void int_thread_del_item(const ERR_STATE *d)
 428         {
 429         ERR_STATE *p;
 430         LHASH *hash;
 431         err_fns_check();
 432         hash = ERRFN(thread_get)();
 433         if(!hash)
 434                 return;
 435         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 436         p = (ERR_STATE *)lh_delete(hash, d);
 437         /* make sure we don't leak memory */
 438         if(int_thread_hash_set && (lh_num_items(int_thread_hash) == 0))
 439                 {
 440                 lh_free(int_thread_hash);
 441                 int_thread_hash = NULL;
 442                 int_thread_hash_set = 0;
 443                 }
 444         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 445         if(p)
 446                 ERR_STATE_free(p);
 447         }
 448 static int int_err_get_next_lib(void)
 449         {
 450         int toret;
 451         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 452         toret = int_err_library_number++;
 453         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 454         return toret;
 455         }
 456
 457
 458 #define NUM_SYS_STR_REASONS 127
 459 #define LEN_SYS_STR_REASON 32
 460
 461 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
 462 /* SYS_str_reasons is filled with copies of strerror() results at
 463  * initialization.
 464  * 'errno' values up to 127 should cover all usual errors,
 465  * others will be displayed numerically by ERR_error_string.
 466  * It is crucial that we have something for each reason code
 467  * that occurs in ERR_str_reasons, or bogus reason strings
 468  * will be returned for SYSerr(), which always gets an errno
 469  * value and never one of those 'standard' reason codes. */
 470
 471 static void build_SYS_str_reasons()
 472         {
 473         /* OPENSSL_malloc cannot be used here, use static storage instead */
 474         static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
 475         int i;
 476
 477         CRYPTO_w_lock(CRYPTO_LOCK_ERR_HASH);
 478
 479         for (i = 1; i <= NUM_SYS_STR_REASONS; i++)
 480                 {
 481                 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
 482
 483                 str->error = (unsigned long)i;
 484                 if (str->string == NULL)
 485                         {
 486                         char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
 487                         char *src = strerror(i);
 488                         if (src != NULL)
 489                                 {
 490                                 strncpy(*dest, src, sizeof *dest);
 491                                 (*dest)[sizeof *dest - 1] = '\0';
 492                                 str->string = *dest;
 493                                 }
 494                         }
 495                 if (str->string == NULL)
 496                         str->string = "unknown";
 497                 }
 498
 499         /* Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL},
 500          * as required by ERR_load_strings. */
 501
 502         CRYPTO_w_unlock(CRYPTO_LOCK_ERR_HASH);
 503         }
 504 #endif
 505
 506 #define err_clear_data(p,i) \
 507         if (((p)->err_data[i] != NULL) && \
 508                 (p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
 509                 {  \
 510                 OPENSSL_free((p)->err_data[i]); \
 511                 (p)->err_data[i]=NULL; \
 512                 } \
 513         (p)->err_data_flags[i]=0;
 514
 515 static void ERR_STATE_free(ERR_STATE *s)
 516         {
 517         int i;
 518
 519         if(s == NULL)
 520             return;
 521
 522         for (i=0; i<ERR_NUM_ERRORS; i++)
 523                 {
 524                 err_clear_data(s,i);
 525                 }
 526         OPENSSL_free(s);
 527         }
 528
 529 void ERR_load_ERR_strings(void)
 530         {
 531         static int init=1;
 532
 533         if (init)
 534                 {
 535                 init=0;
 536                 /* We put the first-time check code here to reduce the number of
 537                  * times it is called (then it doesn't get called from
 538                  * ERR_load_strings() loads of times). */
 539                 err_fns_check();
 540 #ifndef OPENSSL_NO_ERR
 541                 ERR_load_strings(0,ERR_str_libraries);
 542                 ERR_load_strings(0,ERR_str_reasons);
 543                 ERR_load_strings(ERR_LIB_SYS,ERR_str_functs);
 544                 build_SYS_str_reasons();
 545                 ERR_load_strings(ERR_LIB_SYS,SYS_str_reasons);
 546 #endif
 547                 }
 548         }
 549
 550 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
 551         {
 552         /* Do this if it hasn't been done already (NB: The order of the "init=0"
 553          * statement and the recursive calls back to this function prevent a
 554          * loop). */
 555         ERR_load_ERR_strings();
 556         while (str->error)
 557                 {
 558                 str->error|=ERR_PACK(lib,0,0);
 559                 ERRFN(err_set_item)(str);
 560                 str++;
 561                 }
 562         }
 563
 564 void ERR_unload_strings(int lib, ERR_STRING_DATA *str)
 565         {
 566         while(str->error)
 567                 {
 568                 str->error|=ERR_PACK(lib,0,0);
 569                 ERRFN(err_del_item)(str);
 570                 str++;
 571                 }
 572         }
 573
 574 void ERR_free_strings(void)
 575         {
 576         err_fns_check();
 577         ERRFN(err_del)();
 578         }
 579
 580 /********************************************************/
 581
 582 void ERR_put_error(int lib, int func, int reason, const char *file,
 583              int line)
 584         {
 585         ERR_STATE *es;
 586
 587 #ifdef _OSD_POSIX
 588         /* In the BS2000-OSD POSIX subsystem, the compiler generates
 589          * path names in the form "*POSIX(/etc/passwd)".
 590          * This dirty hack strips them to something sensible.
 591          * @@@ We shouldn't modify a const string, though.
 592          */
 593         if (strncmp(file,"*POSIX(", sizeof("*POSIX(")-1) == 0) {
 594                 char *end;
 595
 596                 /* Skip the "*POSIX(" prefix */
 597                 file += sizeof("*POSIX(")-1;
 598                 end = &file[strlen(file)-1];
 599                 if (*end == ')')
 600                         *end = '\0';
 601                 /* Optional: use the basename of the path only. */
 602                 if ((end = strrchr(file, '/')) != NULL)
 603                         file = &end[1];
 604         }
 605 #endif
 606         es=ERR_get_state();
 607
 608         es->top=(es->top+1)%ERR_NUM_ERRORS;
 609         if (es->top == es->bottom)
 610                 es->bottom=(es->bottom+1)%ERR_NUM_ERRORS;
 611         es->err_buffer[es->top]=ERR_PACK(lib,func,reason);
 612         es->err_file[es->top]=file;
 613         es->err_line[es->top]=line;
 614         err_clear_data(es,es->top);
 615         }
 616
 617 void ERR_clear_error(void)
 618         {
 619         int i;
 620         ERR_STATE *es;
 621
 622         es=ERR_get_state();
 623
 624         for (i=0; i<ERR_NUM_ERRORS; i++)
 625                 {
 626                 es->err_buffer[i]=0;
 627                 err_clear_data(es,i);
 628                 es->err_file[i]=NULL;
 629                 es->err_line[i]= -1;
 630                 }
 631         es->top=es->bottom=0;
 632         }
 633
 634
 635 unsigned long ERR_get_error(void)
 636         { return(get_error_values(1,NULL,NULL,NULL,NULL)); }
 637
 638 unsigned long ERR_get_error_line(const char **file,
 639              int *line)
 640         { return(get_error_values(1,file,line,NULL,NULL)); }
 641
 642 unsigned long ERR_get_error_line_data(const char **file, int *line,
 643              const char **data, int *flags)
 644         { return(get_error_values(1,file,line,
 645              data,flags)); }
 646
 647 unsigned long ERR_peek_error(void)
 648         { return(get_error_values(0,NULL,NULL,NULL,NULL)); }
 649
 650 unsigned long ERR_peek_error_line(const char **file,
 651              int *line)
 652         { return(get_error_values(0,file,line,NULL,NULL)); }
 653
 654 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 655              const char **data, int *flags)
 656         { return(get_error_values(0,file,line,
 657              data,flags)); }
 658
 659 static unsigned long get_error_values(int inc, const char **file, int *line,
 660              const char **data, int *flags)
 661         {
 662         int i=0;
 663         ERR_STATE *es;
 664         unsigned long ret;
 665
 666         es=ERR_get_state();
 667
 668         if (es->bottom == es->top) return(0);
 669         i=(es->bottom+1)%ERR_NUM_ERRORS;
 670
 671         ret=es->err_buffer[i];
 672         if (inc)
 673                 {
 674                 es->bottom=i;
 675                 es->err_buffer[i]=0;
 676                 }
 677
 678         if ((file != NULL) && (line != NULL))
 679                 {
 680                 if (es->err_file[i] == NULL)
 681                         {
 682                         *file="NA";
 683                         if (line != NULL) *line=0;
 684                         }
 685                 else
 686                         {
 687                         *file=es->err_file[i];
 688                         if (line != NULL) *line=es->err_line[i];
 689                         }
 690                 }
 691
 692         if (data == NULL)
 693                 {
 694                 if (inc)
 695                         {
 696                         err_clear_data(es, i);
 697                         }
 698                 }
 699         else
 700                 {
 701                 if (es->err_data[i] == NULL)
 702                         {
 703                         *data="";
 704                         if (flags != NULL) *flags=0;
 705                         }
 706                 else
 707                         {
 708                         *data=es->err_data[i];
 709                         if (flags != NULL) *flags=es->err_data_flags[i];
 710                         }
 711                 }
 712         return(ret);
 713         }
 714
 715 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
 716         {
 717         char lsbuf[64], fsbuf[64], rsbuf[64];
 718         const char *ls,*fs,*rs;
 719         unsigned long l,f,r;
 720
 721         l=ERR_GET_LIB(e);
 722         f=ERR_GET_FUNC(e);
 723         r=ERR_GET_REASON(e);
 724
 725         ls=ERR_lib_error_string(e);
 726         fs=ERR_func_error_string(e);
 727         rs=ERR_reason_error_string(e);
 728
 729         if (ls == NULL)
 730                 BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 731         if (fs == NULL)
 732                 BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
 733         if (rs == NULL)
 734                 BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 735
 736         BIO_snprintf(buf, len,"error:%08lX:%s:%s:%s", e, ls?ls:lsbuf,
 737                 fs?fs:fsbuf, rs?rs:rsbuf);
 738         if (strlen(buf) == len-1)
 739                 {
 740                 /* output may be truncated; make sure we always have 5
 741                  * colon-separated fields, i.e. 4 colons ... */
 742 #define NUM_COLONS 4
 743                 if (len > NUM_COLONS) /* ... if possible */
 744                         {
 745                         int i;
 746                         char *s = buf;
 747
 748                         for (i = 0; i < NUM_COLONS; i++)
 749                                 {
 750                                 char *colon = strchr(s, ':');
 751                                 if (colon == NULL || colon > &buf[len-1] - NUM_COLONS + i)
 752                                         {
 753                                         /* set colon no. i at last possible position
 754                                          * (buf[len-1] is the terminating 0)*/
 755                                         colon = &buf[len-1] - NUM_COLONS + i;
 756                                         *colon = ':';
 757                                         }
 758                                 s = colon + 1;
 759                                 }
 760                         }
 761                 }
 762         }
 763
 764 /* BAD for multi-threading: uses a local buffer if ret == NULL */
 765 /* ERR_error_string_n should be used instead for ret != NULL
 766  * as ERR_error_string cannot know how large the buffer is */
 767 char *ERR_error_string(unsigned long e, char *ret)
 768         {
 769         static char buf[256];
 770
 771         if (ret == NULL) ret=buf;
 772         ERR_error_string_n(e, ret, 256);
 773
 774         return(ret);
 775         }
 776
 777 LHASH *ERR_get_string_table(void)
 778         {
 779         err_fns_check();
 780         return ERRFN(err_get)();
 781         }
 782
 783 LHASH *ERR_get_err_state_table(void)
 784         {
 785         err_fns_check();
 786         return ERRFN(thread_get)();
 787         }
 788
 789 const char *ERR_lib_error_string(unsigned long e)
 790         {
 791         ERR_STRING_DATA d,*p;
 792         unsigned long l;
 793
 794         err_fns_check();
 795         l=ERR_GET_LIB(e);
 796         d.error=ERR_PACK(l,0,0);
 797         p=ERRFN(err_get_item)(&d);
 798         return((p == NULL)?NULL:p->string);
 799         }
 800
 801 const char *ERR_func_error_string(unsigned long e)
 802         {
 803         ERR_STRING_DATA d,*p;
 804         unsigned long l,f;
 805
 806         err_fns_check();
 807         l=ERR_GET_LIB(e);
 808         f=ERR_GET_FUNC(e);
 809         d.error=ERR_PACK(l,f,0);
 810         p=ERRFN(err_get_item)(&d);
 811         return((p == NULL)?NULL:p->string);
 812         }
 813
 814 const char *ERR_reason_error_string(unsigned long e)
 815         {
 816         ERR_STRING_DATA d,*p=NULL;
 817         unsigned long l,r;
 818
 819         err_fns_check();
 820         l=ERR_GET_LIB(e);
 821         r=ERR_GET_REASON(e);
 822         d.error=ERR_PACK(l,0,r);
 823         p=ERRFN(err_get_item)(&d);
 824         if(!p)
 825                 {
 826                 d.error=ERR_PACK(0,0,r);
 827                 p=ERRFN(err_get_item)(&d);
 828                 }
 829         return((p == NULL)?NULL:p->string);
 830         }
 831
 832 /* static unsigned long err_hash(ERR_STRING_DATA *a) */
 833 static unsigned long err_hash(const void *a_void)
 834         {
 835         unsigned long ret,l;
 836
 837         l=((ERR_STRING_DATA *)a_void)->error;
 838         ret=l^ERR_GET_LIB(l)^ERR_GET_FUNC(l);
 839         return(ret^ret%19*13);
 840         }
 841
 842 /* static int err_cmp(ERR_STRING_DATA *a, ERR_STRING_DATA *b) */
 843 static int err_cmp(const void *a_void, const void *b_void)
 844         {
 845         return((int)(((ERR_STRING_DATA *)a_void)->error -
 846                         ((ERR_STRING_DATA *)b_void)->error));
 847         }
 848
 849 /* static unsigned long pid_hash(ERR_STATE *a) */
 850 static unsigned long pid_hash(const void *a_void)
 851         {
 852         return(((ERR_STATE *)a_void)->pid*13);
 853         }
 854
 855 /* static int pid_cmp(ERR_STATE *a, ERR_STATE *b) */
 856 static int pid_cmp(const void *a_void, const void *b_void)
 857         {
 858         return((int)((long)((ERR_STATE *)a_void)->pid -
 859                         (long)((ERR_STATE *)b_void)->pid));
 860         }
 861
 862 void ERR_remove_state(unsigned long pid)
 863         {
 864         ERR_STATE tmp;
 865         err_fns_check();
 866         if (pid == 0)
 867                 pid=(unsigned long)CRYPTO_thread_id();
 868         tmp.pid=pid;
 869         /* thread_del_item automatically destroys the LHASH if the number of
 870          * items reaches zero. */
 871         ERRFN(thread_del_item)(&tmp);
 872         }
 873
 874 ERR_STATE *ERR_get_state(void)
 875         {
 876         static ERR_STATE fallback;
 877         ERR_STATE *ret,tmp,*tmpp=NULL;
 878         int i;
 879         unsigned long pid;
 880         err_fns_check();
 881         pid=(unsigned long)CRYPTO_thread_id();
 882         tmp.pid=pid;
 883         ret=ERRFN(thread_get_item)(&tmp);
 884
 885         /* ret == the error state, if NULL, make a new one */
 886         if (ret == NULL)
 887                 {
 888                 ret=(ERR_STATE *)OPENSSL_malloc(sizeof(ERR_STATE));
 889                 if (ret == NULL) return(&fallback);
 890                 ret->pid=pid;
 891                 ret->top=0;
 892                 ret->bottom=0;
 893                 for (i=0; i<ERR_NUM_ERRORS; i++)
 894                         {
 895                         ret->err_data[i]=NULL;
 896                         ret->err_data_flags[i]=0;
 897                         }
 898                 tmpp = ERRFN(thread_set_item)(ret);
 899                 /* To check if insertion failed, do a get. */
 900                 if(ERRFN(thread_get_item)(ret) != ret)
 901                         {
 902                         ERR_STATE_free(ret); /* could not insert it */
 903                         return(&fallback);
 904                         }
 905                 /* If a race occured in this function and we came second, tmpp
 906                  * is the first one that we just replaced. */
 907                 if(tmpp)
 908                         ERR_STATE_free(tmpp);
 909                 }
 910         return(ret);
 911         }
 912
 913 int ERR_get_next_error_library(void)
 914         {
 915         err_fns_check();
 916         return ERRFN(get_next_lib)();
 917         }
 918
 919 void ERR_set_error_data(char *data, int flags)
 920         {
 921         ERR_STATE *es;
 922         int i;
 923
 924         es=ERR_get_state();
 925
 926         i=es->top;
 927         if (i == 0)
 928                 i=ERR_NUM_ERRORS-1;
 929
 930         err_clear_data(es,i);
 931         es->err_data[i]=data;
 932         es->err_data_flags[i]=flags;
 933         }
 934
 935 void ERR_add_error_data(int num, ...)
 936         {
 937         va_list args;
 938         int i,n,s;
 939         char *str,*p,*a;
 940
 941         s=80;
 942         str=OPENSSL_malloc(s+1);
 943         if (str == NULL) return;
 944         str[0]='\0';
 945
 946         va_start(args, num);
 947         n=0;
 948         for (i=0; i<num; i++)
 949                 {
 950                 a=va_arg(args, char*);
 951                 /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
 952                 if (a != NULL)
 953                         {
 954                         n+=strlen(a);
 955                         if (n > s)
 956                                 {
 957                                 s=n+20;
 958                                 p=OPENSSL_realloc(str,s+1);
 959                                 if (p == NULL)
 960                                         {
 961                                         OPENSSL_free(str);
 962                                         return;
 963                                         }
 964                                 else
 965                                         str=p;
 966                                 }
 967                         strcat(str,a);
 968                         }
 969                 }
 970         ERR_set_error_data(str,ERR_TXT_MALLOCED|ERR_TXT_STRING);
 971
 972         va_end(args);
 973         }
 974