crypto/err/err.c

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