err.c revision 1.52
1/* $OpenBSD: err.c,v 1.52 2023/04/09 19:10:23 tb Exp $ */ 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-2006 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 <pthread.h> 113#include <stdarg.h> 114#include <stdio.h> 115#include <string.h> 116 117#include <openssl/opensslconf.h> 118 119#include <openssl/bio.h> 120#include <openssl/buffer.h> 121#include <openssl/crypto.h> 122#include <openssl/err.h> 123#include <openssl/lhash.h> 124 125DECLARE_LHASH_OF(ERR_STRING_DATA); 126DECLARE_LHASH_OF(ERR_STATE); 127 128static void err_load_strings(int lib, ERR_STRING_DATA *str); 129 130static void ERR_STATE_free(ERR_STATE *s); 131#ifndef OPENSSL_NO_ERR 132static ERR_STRING_DATA ERR_str_libraries[] = { 133 {ERR_PACK(ERR_LIB_NONE,0,0), "unknown library"}, 134 {ERR_PACK(ERR_LIB_SYS,0,0), "system library"}, 135 {ERR_PACK(ERR_LIB_BN,0,0), "bignum routines"}, 136 {ERR_PACK(ERR_LIB_RSA,0,0), "rsa routines"}, 137 {ERR_PACK(ERR_LIB_DH,0,0), "Diffie-Hellman routines"}, 138 {ERR_PACK(ERR_LIB_EVP,0,0), "digital envelope routines"}, 139 {ERR_PACK(ERR_LIB_BUF,0,0), "memory buffer routines"}, 140 {ERR_PACK(ERR_LIB_OBJ,0,0), "object identifier routines"}, 141 {ERR_PACK(ERR_LIB_PEM,0,0), "PEM routines"}, 142 {ERR_PACK(ERR_LIB_DSA,0,0), "dsa routines"}, 143 {ERR_PACK(ERR_LIB_X509,0,0), "x509 certificate routines"}, 144 {ERR_PACK(ERR_LIB_ASN1,0,0), "asn1 encoding routines"}, 145 {ERR_PACK(ERR_LIB_CONF,0,0), "configuration file routines"}, 146 {ERR_PACK(ERR_LIB_CRYPTO,0,0), "common libcrypto routines"}, 147 {ERR_PACK(ERR_LIB_EC,0,0), "elliptic curve routines"}, 148 {ERR_PACK(ERR_LIB_SSL,0,0), "SSL routines"}, 149 {ERR_PACK(ERR_LIB_BIO,0,0), "BIO routines"}, 150 {ERR_PACK(ERR_LIB_PKCS7,0,0), "PKCS7 routines"}, 151 {ERR_PACK(ERR_LIB_X509V3,0,0), "X509 V3 routines"}, 152 {ERR_PACK(ERR_LIB_PKCS12,0,0), "PKCS12 routines"}, 153 {ERR_PACK(ERR_LIB_RAND,0,0), "random number generator"}, 154 {ERR_PACK(ERR_LIB_DSO,0,0), "DSO support routines"}, 155 {ERR_PACK(ERR_LIB_TS,0,0), "time stamp routines"}, 156 {ERR_PACK(ERR_LIB_ENGINE,0,0), "engine routines"}, 157 {ERR_PACK(ERR_LIB_OCSP,0,0), "OCSP routines"}, 158 {ERR_PACK(ERR_LIB_FIPS,0,0), "FIPS routines"}, 159 {ERR_PACK(ERR_LIB_CMS,0,0), "CMS routines"}, 160 {ERR_PACK(ERR_LIB_HMAC,0,0), "HMAC routines"}, 161 {ERR_PACK(ERR_LIB_GOST,0,0), "GOST routines"}, 162 {0, NULL}, 163}; 164 165static ERR_STRING_DATA ERR_str_functs[] = { 166 {ERR_PACK(0,SYS_F_FOPEN, 0), "fopen"}, 167 {ERR_PACK(0,SYS_F_CONNECT, 0), "connect"}, 168 {ERR_PACK(0,SYS_F_GETSERVBYNAME, 0), "getservbyname"}, 169 {ERR_PACK(0,SYS_F_SOCKET, 0), "socket"}, 170 {ERR_PACK(0,SYS_F_IOCTLSOCKET, 0), "ioctl"}, 171 {ERR_PACK(0,SYS_F_BIND, 0), "bind"}, 172 {ERR_PACK(0,SYS_F_LISTEN, 0), "listen"}, 173 {ERR_PACK(0,SYS_F_ACCEPT, 0), "accept"}, 174 {ERR_PACK(0,SYS_F_OPENDIR, 0), "opendir"}, 175 {ERR_PACK(0,SYS_F_FREAD, 0), "fread"}, 176 {0, NULL}, 177}; 178 179static ERR_STRING_DATA ERR_str_reasons[] = { 180 {ERR_R_SYS_LIB, "system lib"}, 181 {ERR_R_BN_LIB, "BN lib"}, 182 {ERR_R_RSA_LIB, "RSA lib"}, 183 {ERR_R_DH_LIB, "DH lib"}, 184 {ERR_R_EVP_LIB, "EVP lib"}, 185 {ERR_R_BUF_LIB, "BUF lib"}, 186 {ERR_R_OBJ_LIB, "OBJ lib"}, 187 {ERR_R_PEM_LIB, "PEM lib"}, 188 {ERR_R_DSA_LIB, "DSA lib"}, 189 {ERR_R_X509_LIB, "X509 lib"}, 190 {ERR_R_ASN1_LIB, "ASN1 lib"}, 191 {ERR_R_CONF_LIB, "CONF lib"}, 192 {ERR_R_CRYPTO_LIB, "CRYPTO lib"}, 193 {ERR_R_EC_LIB, "EC lib"}, 194 {ERR_R_SSL_LIB, "SSL lib"}, 195 {ERR_R_BIO_LIB, "BIO lib"}, 196 {ERR_R_PKCS7_LIB, "PKCS7 lib"}, 197 {ERR_R_X509V3_LIB, "X509V3 lib"}, 198 {ERR_R_PKCS12_LIB, "PKCS12 lib"}, 199 {ERR_R_RAND_LIB, "RAND lib"}, 200 {ERR_R_DSO_LIB, "DSO lib"}, 201 {ERR_R_ENGINE_LIB, "ENGINE lib"}, 202 {ERR_R_OCSP_LIB, "OCSP lib"}, 203 {ERR_R_TS_LIB, "TS lib"}, 204 205 {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"}, 206 {ERR_R_BAD_ASN1_OBJECT_HEADER, "bad asn1 object header"}, 207 {ERR_R_BAD_GET_ASN1_OBJECT_CALL, "bad get asn1 object call"}, 208 {ERR_R_EXPECTING_AN_ASN1_SEQUENCE, "expecting an asn1 sequence"}, 209 {ERR_R_ASN1_LENGTH_MISMATCH, "asn1 length mismatch"}, 210 {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"}, 211 212 {ERR_R_FATAL, "fatal"}, 213 {ERR_R_MALLOC_FAILURE, "malloc failure"}, 214 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED, "called a function you should not call"}, 215 {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"}, 216 {ERR_R_INTERNAL_ERROR, "internal error"}, 217 {ERR_R_DISABLED , "called a function that was disabled at compile-time"}, 218 {ERR_R_INIT_FAIL, "initialization failure"}, 219 220 {0, NULL}, 221}; 222#endif 223 224 225/* Define the predeclared (but externally opaque) "ERR_FNS" type */ 226struct st_ERR_FNS { 227 /* Works on the "error_hash" string table */ 228 LHASH_OF(ERR_STRING_DATA) *(*cb_err_get)(int create); 229 void (*cb_err_del)(void); 230 ERR_STRING_DATA *(*cb_err_get_item)(const ERR_STRING_DATA *); 231 ERR_STRING_DATA *(*cb_err_set_item)(ERR_STRING_DATA *); 232 ERR_STRING_DATA *(*cb_err_del_item)(ERR_STRING_DATA *); 233 /* Works on the "thread_hash" error-state table */ 234 LHASH_OF(ERR_STATE) *(*cb_thread_get)(int create); 235 void (*cb_thread_release)(LHASH_OF(ERR_STATE) **hash); 236 ERR_STATE *(*cb_thread_get_item)(const ERR_STATE *); 237 ERR_STATE *(*cb_thread_set_item)(ERR_STATE *); 238 void (*cb_thread_del_item)(const ERR_STATE *); 239 /* Returns the next available error "library" numbers */ 240 int (*cb_get_next_lib)(void); 241}; 242 243/* Predeclarations of the "err_defaults" functions */ 244static LHASH_OF(ERR_STRING_DATA) *int_err_get(int create); 245static void int_err_del(void); 246static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *); 247static ERR_STRING_DATA *int_err_set_item(ERR_STRING_DATA *); 248static ERR_STRING_DATA *int_err_del_item(ERR_STRING_DATA *); 249static LHASH_OF(ERR_STATE) *int_thread_get(int create); 250static void int_thread_release(LHASH_OF(ERR_STATE) **hash); 251static ERR_STATE *int_thread_get_item(const ERR_STATE *); 252static ERR_STATE *int_thread_set_item(ERR_STATE *); 253static void int_thread_del_item(const ERR_STATE *); 254static int int_err_get_next_lib(void); 255 256/* The static ERR_FNS table using these defaults functions */ 257static const ERR_FNS err_defaults = { 258 int_err_get, 259 int_err_del, 260 int_err_get_item, 261 int_err_set_item, 262 int_err_del_item, 263 int_thread_get, 264 int_thread_release, 265 int_thread_get_item, 266 int_thread_set_item, 267 int_thread_del_item, 268 int_err_get_next_lib 269}; 270 271/* The replacable table of ERR_FNS functions we use at run-time */ 272static const ERR_FNS *err_fns = NULL; 273 274/* Eg. rather than using "err_get()", use "ERRFN(err_get)()". */ 275#define ERRFN(a) err_fns->cb_##a 276 277/* The internal state used by "err_defaults" - as such, the setting, reading, 278 * creating, and deleting of this data should only be permitted via the 279 * "err_defaults" functions. This way, a linked module can completely defer all 280 * ERR state operation (together with requisite locking) to the implementations 281 * and state in the loading application. */ 282static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL; 283static LHASH_OF(ERR_STATE) *int_thread_hash = NULL; 284static int int_thread_hash_references = 0; 285static int int_err_library_number = ERR_LIB_USER; 286 287static pthread_t err_init_thread; 288 289/* Internal function that checks whether "err_fns" is set and if not, sets it to 290 * the defaults. */ 291static void 292err_fns_check(void) 293{ 294 if (err_fns) 295 return; 296 297 CRYPTO_w_lock(CRYPTO_LOCK_ERR); 298 if (!err_fns) 299 err_fns = &err_defaults; 300 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 301} 302 303/* API functions to get or set the underlying ERR functions. */ 304 305const ERR_FNS * 306ERR_get_implementation(void) 307{ 308 err_fns_check(); 309 return err_fns; 310} 311 312int 313ERR_set_implementation(const ERR_FNS *fns) 314{ 315 int ret = 0; 316 317 CRYPTO_w_lock(CRYPTO_LOCK_ERR); 318 /* It's too late if 'err_fns' is non-NULL. BTW: not much point setting 319 * an error is there?! */ 320 if (!err_fns) { 321 err_fns = fns; 322 ret = 1; 323 } 324 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 325 return ret; 326} 327 328/* These are the callbacks provided to "lh_new()" when creating the LHASH tables 329 * internal to the "err_defaults" implementation. */ 330 331static unsigned long get_error_values(int inc, int top, const char **file, 332 int *line, const char **data, int *flags); 333 334/* The internal functions used in the "err_defaults" implementation */ 335 336static unsigned long 337err_string_data_hash(const ERR_STRING_DATA *a) 338{ 339 unsigned long ret, l; 340 341 l = a->error; 342 ret = l^ERR_GET_LIB(l)^ERR_GET_FUNC(l); 343 return (ret^ret % 19*13); 344} 345static IMPLEMENT_LHASH_HASH_FN(err_string_data, ERR_STRING_DATA) 346 347static int 348err_string_data_cmp(const ERR_STRING_DATA *a, const ERR_STRING_DATA *b) 349{ 350 return (int)(a->error - b->error); 351} 352static IMPLEMENT_LHASH_COMP_FN(err_string_data, ERR_STRING_DATA) 353 354static 355LHASH_OF(ERR_STRING_DATA) *int_err_get(int create) 356{ 357 LHASH_OF(ERR_STRING_DATA) *ret = NULL; 358 359 CRYPTO_w_lock(CRYPTO_LOCK_ERR); 360 if (!int_error_hash && create) { 361 CRYPTO_push_info("int_err_get (err.c)"); 362 int_error_hash = lh_ERR_STRING_DATA_new(); 363 CRYPTO_pop_info(); 364 } 365 if (int_error_hash) 366 ret = int_error_hash; 367 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 368 369 return ret; 370} 371 372static void 373int_err_del(void) 374{ 375 CRYPTO_w_lock(CRYPTO_LOCK_ERR); 376 if (int_error_hash) { 377 lh_ERR_STRING_DATA_free(int_error_hash); 378 int_error_hash = NULL; 379 } 380 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 381} 382 383static ERR_STRING_DATA * 384int_err_get_item(const ERR_STRING_DATA *d) 385{ 386 ERR_STRING_DATA *p; 387 LHASH_OF(ERR_STRING_DATA) *hash; 388 389 err_fns_check(); 390 hash = ERRFN(err_get)(0); 391 if (!hash) 392 return NULL; 393 394 CRYPTO_r_lock(CRYPTO_LOCK_ERR); 395 p = lh_ERR_STRING_DATA_retrieve(hash, d); 396 CRYPTO_r_unlock(CRYPTO_LOCK_ERR); 397 398 return p; 399} 400 401static ERR_STRING_DATA * 402int_err_set_item(ERR_STRING_DATA *d) 403{ 404 ERR_STRING_DATA *p; 405 LHASH_OF(ERR_STRING_DATA) *hash; 406 407 err_fns_check(); 408 hash = ERRFN(err_get)(1); 409 if (!hash) 410 return NULL; 411 412 CRYPTO_w_lock(CRYPTO_LOCK_ERR); 413 p = lh_ERR_STRING_DATA_insert(hash, d); 414 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 415 416 return p; 417} 418 419static ERR_STRING_DATA * 420int_err_del_item(ERR_STRING_DATA *d) 421{ 422 ERR_STRING_DATA *p; 423 LHASH_OF(ERR_STRING_DATA) *hash; 424 425 err_fns_check(); 426 hash = ERRFN(err_get)(0); 427 if (!hash) 428 return NULL; 429 430 CRYPTO_w_lock(CRYPTO_LOCK_ERR); 431 p = lh_ERR_STRING_DATA_delete(hash, d); 432 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 433 434 return p; 435} 436 437static unsigned long 438err_state_hash(const ERR_STATE *a) 439{ 440 return CRYPTO_THREADID_hash(&a->tid) * 13; 441} 442static IMPLEMENT_LHASH_HASH_FN(err_state, ERR_STATE) 443 444static int 445err_state_cmp(const ERR_STATE *a, const ERR_STATE *b) 446{ 447 return CRYPTO_THREADID_cmp(&a->tid, &b->tid); 448} 449static IMPLEMENT_LHASH_COMP_FN(err_state, ERR_STATE) 450 451static 452LHASH_OF(ERR_STATE) *int_thread_get(int create) 453{ 454 LHASH_OF(ERR_STATE) *ret = NULL; 455 456 CRYPTO_w_lock(CRYPTO_LOCK_ERR); 457 if (!int_thread_hash && create) { 458 CRYPTO_push_info("int_thread_get (err.c)"); 459 int_thread_hash = lh_ERR_STATE_new(); 460 CRYPTO_pop_info(); 461 } 462 if (int_thread_hash) { 463 int_thread_hash_references++; 464 ret = int_thread_hash; 465 } 466 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 467 return ret; 468} 469 470static void 471int_thread_release(LHASH_OF(ERR_STATE) **hash) 472{ 473 int i; 474 475 if (hash == NULL || *hash == NULL) 476 return; 477 478 i = CRYPTO_add(&int_thread_hash_references, -1, CRYPTO_LOCK_ERR); 479 if (i > 0) 480 return; 481 482 *hash = NULL; 483} 484 485static ERR_STATE * 486int_thread_get_item(const ERR_STATE *d) 487{ 488 ERR_STATE *p; 489 LHASH_OF(ERR_STATE) *hash; 490 491 err_fns_check(); 492 hash = ERRFN(thread_get)(0); 493 if (!hash) 494 return NULL; 495 496 CRYPTO_r_lock(CRYPTO_LOCK_ERR); 497 p = lh_ERR_STATE_retrieve(hash, d); 498 CRYPTO_r_unlock(CRYPTO_LOCK_ERR); 499 500 ERRFN(thread_release)(&hash); 501 return p; 502} 503 504static ERR_STATE * 505int_thread_set_item(ERR_STATE *d) 506{ 507 ERR_STATE *p; 508 LHASH_OF(ERR_STATE) *hash; 509 510 err_fns_check(); 511 hash = ERRFN(thread_get)(1); 512 if (!hash) 513 return NULL; 514 515 CRYPTO_w_lock(CRYPTO_LOCK_ERR); 516 p = lh_ERR_STATE_insert(hash, d); 517 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 518 519 ERRFN(thread_release)(&hash); 520 return p; 521} 522 523static void 524int_thread_del_item(const ERR_STATE *d) 525{ 526 ERR_STATE *p; 527 LHASH_OF(ERR_STATE) *hash; 528 529 err_fns_check(); 530 hash = ERRFN(thread_get)(0); 531 if (!hash) 532 return; 533 534 CRYPTO_w_lock(CRYPTO_LOCK_ERR); 535 p = lh_ERR_STATE_delete(hash, d); 536 /* make sure we don't leak memory */ 537 if (int_thread_hash_references == 1 && 538 int_thread_hash && lh_ERR_STATE_num_items(int_thread_hash) == 0) { 539 lh_ERR_STATE_free(int_thread_hash); 540 int_thread_hash = NULL; 541 } 542 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 543 544 ERRFN(thread_release)(&hash); 545 if (p) 546 ERR_STATE_free(p); 547} 548 549static int 550int_err_get_next_lib(void) 551{ 552 int ret; 553 554 CRYPTO_w_lock(CRYPTO_LOCK_ERR); 555 ret = int_err_library_number++; 556 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 557 558 return ret; 559} 560 561 562#ifndef OPENSSL_NO_ERR 563#define NUM_SYS_STR_REASONS 127 564#define LEN_SYS_STR_REASON 32 565 566static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1]; 567/* SYS_str_reasons is filled with copies of strerror() results at 568 * initialization. 569 * 'errno' values up to 127 should cover all usual errors, 570 * others will be displayed numerically by ERR_error_string. 571 * It is crucial that we have something for each reason code 572 * that occurs in ERR_str_reasons, or bogus reason strings 573 * will be returned for SYSerror(which always gets an errno 574 * value and never one of those 'standard' reason codes. */ 575 576static void 577build_SYS_str_reasons(void) 578{ 579 /* malloc cannot be used here, use static storage instead */ 580 static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON]; 581 int i; 582 static int init = 1; 583 int save_errno; 584 585 CRYPTO_r_lock(CRYPTO_LOCK_ERR); 586 if (!init) { 587 CRYPTO_r_unlock(CRYPTO_LOCK_ERR); 588 return; 589 } 590 591 CRYPTO_r_unlock(CRYPTO_LOCK_ERR); 592 CRYPTO_w_lock(CRYPTO_LOCK_ERR); 593 if (!init) { 594 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 595 return; 596 } 597 598 /* strerror(3) will set errno to EINVAL when i is an unknown errno. */ 599 save_errno = errno; 600 for (i = 1; i <= NUM_SYS_STR_REASONS; i++) { 601 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1]; 602 603 str->error = (unsigned long)i; 604 if (str->string == NULL) { 605 char (*dest)[LEN_SYS_STR_REASON] = 606 &(strerror_tab[i - 1]); 607 const char *src = strerror(i); 608 if (src != NULL) { 609 strlcpy(*dest, src, sizeof *dest); 610 str->string = *dest; 611 } 612 } 613 if (str->string == NULL) 614 str->string = "unknown"; 615 } 616 errno = save_errno; 617 618 /* Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, 619 * as required by ERR_load_strings. */ 620 621 init = 0; 622 623 CRYPTO_w_unlock(CRYPTO_LOCK_ERR); 624} 625#endif 626 627#define err_clear_data(p,i) \ 628 do { \ 629 if (((p)->err_data[i] != NULL) && \ 630 (p)->err_data_flags[i] & ERR_TXT_MALLOCED) { \ 631 free((p)->err_data[i]); \ 632 (p)->err_data[i] = NULL; \ 633 } \ 634 (p)->err_data_flags[i] = 0; \ 635 } while(0) 636 637#define err_clear(p,i) \ 638 do { \ 639 (p)->err_flags[i] = 0; \ 640 (p)->err_buffer[i] = 0; \ 641 err_clear_data(p, i); \ 642 (p)->err_file[i] = NULL; \ 643 (p)->err_line[i] = -1; \ 644 } while(0) 645 646static void 647ERR_STATE_free(ERR_STATE *s) 648{ 649 int i; 650 651 if (s == NULL) 652 return; 653 654 for (i = 0; i < ERR_NUM_ERRORS; i++) { 655 err_clear_data(s, i); 656 } 657 free(s); 658} 659 660void 661ERR_load_ERR_strings_internal(void) 662{ 663 err_init_thread = pthread_self(); 664 err_fns_check(); 665#ifndef OPENSSL_NO_ERR 666 err_load_strings(0, ERR_str_libraries); 667 err_load_strings(0, ERR_str_reasons); 668 err_load_strings(ERR_LIB_SYS, ERR_str_functs); 669 build_SYS_str_reasons(); 670 err_load_strings(ERR_LIB_SYS, SYS_str_reasons); 671#endif 672} 673 674 675void 676ERR_load_ERR_strings(void) 677{ 678 static pthread_once_t once = PTHREAD_ONCE_INIT; 679 680 if (pthread_equal(pthread_self(), err_init_thread)) 681 return; /* don't recurse */ 682 683 /* Prayer and clean living lets you ignore errors, OpenSSL style */ 684 (void) OPENSSL_init_crypto(0, NULL); 685 686 (void) pthread_once(&once, ERR_load_ERR_strings_internal); 687} 688 689static void 690err_load_strings(int lib, ERR_STRING_DATA *str) 691{ 692 while (str->error) { 693 if (lib) 694 str->error |= ERR_PACK(lib, 0, 0); 695 ERRFN(err_set_item)(str); 696 str++; 697 } 698} 699 700void 701ERR_load_strings(int lib, ERR_STRING_DATA *str) 702{ 703 ERR_load_ERR_strings(); 704 err_load_strings(lib, str); 705} 706 707void 708ERR_unload_strings(int lib, ERR_STRING_DATA *str) 709{ 710 /* Prayer and clean living lets you ignore errors, OpenSSL style */ 711 (void) OPENSSL_init_crypto(0, NULL); 712 713 while (str->error) { 714 if (lib) 715 str->error |= ERR_PACK(lib, 0, 0); 716 ERRFN(err_del_item)(str); 717 str++; 718 } 719} 720 721void 722ERR_free_strings(void) 723{ 724 /* Prayer and clean living lets you ignore errors, OpenSSL style */ 725 (void) OPENSSL_init_crypto(0, NULL); 726 727 err_fns_check(); 728 ERRFN(err_del)(); 729} 730 731/********************************************************/ 732 733void 734ERR_put_error(int lib, int func, int reason, const char *file, int line) 735{ 736 ERR_STATE *es; 737 int save_errno = errno; 738 739 es = ERR_get_state(); 740 741 es->top = (es->top + 1) % ERR_NUM_ERRORS; 742 if (es->top == es->bottom) 743 es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS; 744 es->err_flags[es->top] = 0; 745 es->err_buffer[es->top] = ERR_PACK(lib, func, reason); 746 es->err_file[es->top] = file; 747 es->err_line[es->top] = line; 748 err_clear_data(es, es->top); 749 errno = save_errno; 750} 751 752void 753ERR_clear_error(void) 754{ 755 int i; 756 ERR_STATE *es; 757 758 es = ERR_get_state(); 759 760 for (i = 0; i < ERR_NUM_ERRORS; i++) { 761 err_clear(es, i); 762 } 763 es->top = es->bottom = 0; 764} 765 766 767unsigned long 768ERR_get_error(void) 769{ 770 return (get_error_values(1, 0, NULL, NULL, NULL, NULL)); 771} 772 773unsigned long 774ERR_get_error_line(const char **file, int *line) 775{ 776 return (get_error_values(1, 0, file, line, NULL, NULL)); 777} 778 779unsigned long 780ERR_get_error_line_data(const char **file, int *line, 781 const char **data, int *flags) 782{ 783 return (get_error_values(1, 0, file, line, data, flags)); 784} 785 786 787unsigned long 788ERR_peek_error(void) 789{ 790 return (get_error_values(0, 0, NULL, NULL, NULL, NULL)); 791} 792 793unsigned long 794ERR_peek_error_line(const char **file, int *line) 795{ 796 return (get_error_values(0, 0, file, line, NULL, NULL)); 797} 798 799unsigned long 800ERR_peek_error_line_data(const char **file, int *line, 801 const char **data, int *flags) 802{ 803 return (get_error_values(0, 0, file, line, data, flags)); 804} 805 806unsigned long 807ERR_peek_last_error(void) 808{ 809 return (get_error_values(0, 1, NULL, NULL, NULL, NULL)); 810} 811 812unsigned long 813ERR_peek_last_error_line(const char **file, int *line) 814{ 815 return (get_error_values(0, 1, file, line, NULL, NULL)); 816} 817 818unsigned long 819ERR_peek_last_error_line_data(const char **file, int *line, 820 const char **data, int *flags) 821{ 822 return (get_error_values(0, 1, file, line, data, flags)); 823} 824 825static unsigned long 826get_error_values(int inc, int top, const char **file, int *line, 827 const char **data, int *flags) 828{ 829 int i = 0; 830 ERR_STATE *es; 831 unsigned long ret; 832 833 es = ERR_get_state(); 834 835 if (inc && top) { 836 if (file) 837 *file = ""; 838 if (line) 839 *line = 0; 840 if (data) 841 *data = ""; 842 if (flags) 843 *flags = 0; 844 845 return ERR_R_INTERNAL_ERROR; 846 } 847 848 if (es->bottom == es->top) 849 return 0; 850 if (top) 851 i = es->top; /* last error */ 852 else 853 i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */ 854 855 ret = es->err_buffer[i]; 856 if (inc) { 857 es->bottom = i; 858 es->err_buffer[i] = 0; 859 } 860 861 if ((file != NULL) && (line != NULL)) { 862 if (es->err_file[i] == NULL) { 863 *file = "NA"; 864 if (line != NULL) 865 *line = 0; 866 } else { 867 *file = es->err_file[i]; 868 if (line != NULL) 869 *line = es->err_line[i]; 870 } 871 } 872 873 if (data == NULL) { 874 if (inc) { 875 err_clear_data(es, i); 876 } 877 } else { 878 if (es->err_data[i] == NULL) { 879 *data = ""; 880 if (flags != NULL) 881 *flags = 0; 882 } else { 883 *data = es->err_data[i]; 884 if (flags != NULL) 885 *flags = es->err_data_flags[i]; 886 } 887 } 888 return ret; 889} 890 891void 892ERR_error_string_n(unsigned long e, char *buf, size_t len) 893{ 894 char lsbuf[30], fsbuf[30], rsbuf[30]; 895 const char *ls, *fs, *rs; 896 int l, f, r, ret; 897 898 l = ERR_GET_LIB(e); 899 f = ERR_GET_FUNC(e); 900 r = ERR_GET_REASON(e); 901 902 ls = ERR_lib_error_string(e); 903 fs = ERR_func_error_string(e); 904 rs = ERR_reason_error_string(e); 905 906 if (ls == NULL) { 907 (void) snprintf(lsbuf, sizeof(lsbuf), "lib(%d)", l); 908 ls = lsbuf; 909 } 910 if (fs == NULL) { 911 (void) snprintf(fsbuf, sizeof(fsbuf), "func(%d)", f); 912 fs = fsbuf; 913 } 914 if (rs == NULL) { 915 (void) snprintf(rsbuf, sizeof(rsbuf), "reason(%d)", r); 916 rs = rsbuf; 917 } 918 919 ret = snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, fs, rs); 920 if (ret == -1) 921 return; /* can't happen, and can't do better if it does */ 922 if (ret >= len) { 923 /* output may be truncated; make sure we always have 5 924 * colon-separated fields, i.e. 4 colons ... */ 925#define NUM_COLONS 4 926 if (len > NUM_COLONS) /* ... if possible */ 927 { 928 int i; 929 char *s = buf; 930 931 for (i = 0; i < NUM_COLONS; i++) { 932 char *colon = strchr(s, ':'); 933 if (colon == NULL || 934 colon > &buf[len - 1] - NUM_COLONS + i) { 935 /* set colon no. i at last possible position 936 * (buf[len-1] is the terminating 0)*/ 937 colon = &buf[len - 1] - NUM_COLONS + i; 938 *colon = ':'; 939 } 940 s = colon + 1; 941 } 942 } 943 } 944} 945 946/* BAD for multi-threading: uses a local buffer if ret == NULL */ 947/* ERR_error_string_n should be used instead for ret != NULL 948 * as ERR_error_string cannot know how large the buffer is */ 949char * 950ERR_error_string(unsigned long e, char *ret) 951{ 952 static char buf[256]; 953 954 if (ret == NULL) 955 ret = buf; 956 ERR_error_string_n(e, ret, 256); 957 958 return ret; 959} 960 961LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void) 962{ 963 err_fns_check(); 964 return ERRFN(err_get)(0); 965} 966 967LHASH_OF(ERR_STATE) *ERR_get_err_state_table(void) 968{ 969 err_fns_check(); 970 return ERRFN(thread_get)(0); 971} 972 973void 974ERR_release_err_state_table(LHASH_OF(ERR_STATE) **hash) 975{ 976 err_fns_check(); 977 ERRFN(thread_release)(hash); 978} 979 980const char * 981ERR_lib_error_string(unsigned long e) 982{ 983 ERR_STRING_DATA d, *p; 984 unsigned long l; 985 986 if (!OPENSSL_init_crypto(0, NULL)) 987 return NULL; 988 989 err_fns_check(); 990 l = ERR_GET_LIB(e); 991 d.error = ERR_PACK(l, 0, 0); 992 p = ERRFN(err_get_item)(&d); 993 return ((p == NULL) ? NULL : p->string); 994} 995 996const char * 997ERR_func_error_string(unsigned long e) 998{ 999 ERR_STRING_DATA d, *p; 1000 unsigned long l, f; 1001 1002 err_fns_check(); 1003 l = ERR_GET_LIB(e); 1004 f = ERR_GET_FUNC(e); 1005 d.error = ERR_PACK(l, f, 0); 1006 p = ERRFN(err_get_item)(&d); 1007 return ((p == NULL) ? NULL : p->string); 1008} 1009 1010const char * 1011ERR_reason_error_string(unsigned long e) 1012{ 1013 ERR_STRING_DATA d, *p = NULL; 1014 unsigned long l, r; 1015 1016 err_fns_check(); 1017 l = ERR_GET_LIB(e); 1018 r = ERR_GET_REASON(e); 1019 d.error = ERR_PACK(l, 0, r); 1020 p = ERRFN(err_get_item)(&d); 1021 if (!p) { 1022 d.error = ERR_PACK(0, 0, r); 1023 p = ERRFN(err_get_item)(&d); 1024 } 1025 return ((p == NULL) ? NULL : p->string); 1026} 1027 1028void 1029ERR_remove_thread_state(const CRYPTO_THREADID *id) 1030{ 1031 ERR_STATE tmp; 1032 1033 if (id) 1034 CRYPTO_THREADID_cpy(&tmp.tid, id); 1035 else 1036 CRYPTO_THREADID_current(&tmp.tid); 1037 err_fns_check(); 1038 /* thread_del_item automatically destroys the LHASH if the number of 1039 * items reaches zero. */ 1040 ERRFN(thread_del_item)(&tmp); 1041} 1042 1043void 1044ERR_remove_state(unsigned long pid) 1045{ 1046 ERR_remove_thread_state(NULL); 1047} 1048 1049ERR_STATE * 1050ERR_get_state(void) 1051{ 1052 static ERR_STATE fallback; 1053 ERR_STATE *ret, tmp, *tmpp = NULL; 1054 int i; 1055 CRYPTO_THREADID tid; 1056 1057 err_fns_check(); 1058 CRYPTO_THREADID_current(&tid); 1059 CRYPTO_THREADID_cpy(&tmp.tid, &tid); 1060 ret = ERRFN(thread_get_item)(&tmp); 1061 1062 /* ret == the error state, if NULL, make a new one */ 1063 if (ret == NULL) { 1064 ret = malloc(sizeof(ERR_STATE)); 1065 if (ret == NULL) 1066 return (&fallback); 1067 CRYPTO_THREADID_cpy(&ret->tid, &tid); 1068 ret->top = 0; 1069 ret->bottom = 0; 1070 for (i = 0; i < ERR_NUM_ERRORS; i++) { 1071 ret->err_data[i] = NULL; 1072 ret->err_data_flags[i] = 0; 1073 } 1074 tmpp = ERRFN(thread_set_item)(ret); 1075 /* To check if insertion failed, do a get. */ 1076 if (ERRFN(thread_get_item)(ret) != ret) { 1077 ERR_STATE_free(ret); /* could not insert it */ 1078 return (&fallback); 1079 } 1080 /* If a race occurred in this function and we came second, tmpp 1081 * is the first one that we just replaced. */ 1082 if (tmpp) 1083 ERR_STATE_free(tmpp); 1084 } 1085 return ret; 1086} 1087 1088int 1089ERR_get_next_error_library(void) 1090{ 1091 err_fns_check(); 1092 return ERRFN(get_next_lib)(); 1093} 1094 1095void 1096ERR_set_error_data(char *data, int flags) 1097{ 1098 ERR_STATE *es; 1099 int i; 1100 1101 es = ERR_get_state(); 1102 1103 i = es->top; 1104 if (i == 0) 1105 i = ERR_NUM_ERRORS - 1; 1106 1107 err_clear_data(es, i); 1108 es->err_data[i] = data; 1109 es->err_data_flags[i] = flags; 1110} 1111 1112void 1113ERR_asprintf_error_data(char * format, ...) 1114{ 1115 char *errbuf = NULL; 1116 va_list ap; 1117 int r; 1118 1119 va_start(ap, format); 1120 r = vasprintf(&errbuf, format, ap); 1121 va_end(ap); 1122 if (r == -1) 1123 ERR_set_error_data("malloc failed", ERR_TXT_STRING); 1124 else 1125 ERR_set_error_data(errbuf, ERR_TXT_MALLOCED|ERR_TXT_STRING); 1126} 1127 1128void 1129ERR_add_error_vdata(int num, va_list args) 1130{ 1131 char format[129]; 1132 char *errbuf; 1133 int i; 1134 1135 format[0] = '\0'; 1136 for (i = 0; i < num; i++) { 1137 if (strlcat(format, "%s", sizeof(format)) >= sizeof(format)) { 1138 ERR_set_error_data("too many errors", ERR_TXT_STRING); 1139 return; 1140 } 1141 } 1142 if (vasprintf(&errbuf, format, args) == -1) 1143 ERR_set_error_data("malloc failed", ERR_TXT_STRING); 1144 else 1145 ERR_set_error_data(errbuf, ERR_TXT_MALLOCED|ERR_TXT_STRING); 1146} 1147 1148void 1149ERR_add_error_data(int num, ...) 1150{ 1151 va_list args; 1152 va_start(args, num); 1153 ERR_add_error_vdata(num, args); 1154 va_end(args); 1155} 1156 1157int 1158ERR_set_mark(void) 1159{ 1160 ERR_STATE *es; 1161 1162 es = ERR_get_state(); 1163 1164 if (es->bottom == es->top) 1165 return 0; 1166 es->err_flags[es->top] |= ERR_FLAG_MARK; 1167 return 1; 1168} 1169 1170int 1171ERR_pop_to_mark(void) 1172{ 1173 ERR_STATE *es; 1174 1175 es = ERR_get_state(); 1176 1177 while (es->bottom != es->top && 1178 (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) { 1179 err_clear(es, es->top); 1180 es->top -= 1; 1181 if (es->top == -1) 1182 es->top = ERR_NUM_ERRORS - 1; 1183 } 1184 1185 if (es->bottom == es->top) 1186 return 0; 1187 es->err_flags[es->top]&=~ERR_FLAG_MARK; 1188 return 1; 1189} 1190 1191void 1192err_clear_last_constant_time(int clear) 1193{ 1194 ERR_STATE *es; 1195 int top; 1196 1197 es = ERR_get_state(); 1198 if (es == NULL) 1199 return; 1200 1201 top = es->top; 1202 1203 es->err_flags[top] &= ~(0 - clear); 1204 es->err_buffer[top] &= ~(0UL - clear); 1205 es->err_file[top] = (const char *)((uintptr_t)es->err_file[top] & 1206 ~((uintptr_t)0 - clear)); 1207 es->err_line[top] |= 0 - clear; 1208 1209 es->top = (top + ERR_NUM_ERRORS - clear) % ERR_NUM_ERRORS; 1210} 1211