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