1 /* 2 * Copyright 1995-2019 The OpenSSL Project Authors. All Rights Reserved. 3 * 4 * Licensed under the OpenSSL license (the "License"). You may not use 5 * this file except in compliance with the License. You can obtain a copy 6 * in the file LICENSE in the source distribution or at 7 * https://www.openssl.org/source/license.html 8 */ 9 10 #include <stdio.h> 11 #include <stdarg.h> 12 #include <string.h> 13 #include "internal/cryptlib_int.h" 14 #include "internal/err.h" 15 #include "internal/err_int.h" 16 #include <openssl/err.h> 17 #include <openssl/crypto.h> 18 #include <openssl/buffer.h> 19 #include <openssl/bio.h> 20 #include <openssl/opensslconf.h> 21 #include "internal/thread_once.h" 22 #include "internal/ctype.h" 23 #include "internal/constant_time_locl.h" 24 #include "e_os.h" 25 26 static int err_load_strings(const ERR_STRING_DATA *str); 27 28 static void ERR_STATE_free(ERR_STATE *s); 29 #ifndef OPENSSL_NO_ERR 30 static ERR_STRING_DATA ERR_str_libraries[] = { 31 {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"}, 32 {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"}, 33 {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"}, 34 {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"}, 35 {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"}, 36 {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"}, 37 {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"}, 38 {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"}, 39 {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"}, 40 {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"}, 41 {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"}, 42 {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"}, 43 {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"}, 44 {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"}, 45 {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"}, 46 {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"}, 47 {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"}, 48 {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"}, 49 {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"}, 50 {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"}, 51 {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"}, 52 {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"}, 53 {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"}, 54 {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"}, 55 {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"}, 56 {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"}, 57 {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"}, 58 {ERR_PACK(ERR_LIB_UI, 0, 0), "UI routines"}, 59 {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"}, 60 {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"}, 61 {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"}, 62 {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"}, 63 {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"}, 64 {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"}, 65 {ERR_PACK(ERR_LIB_OSSL_STORE, 0, 0), "STORE routines"}, 66 {ERR_PACK(ERR_LIB_SM2, 0, 0), "SM2 routines"}, 67 {0, NULL}, 68 }; 69 70 static ERR_STRING_DATA ERR_str_functs[] = { 71 {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"}, 72 {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"}, 73 {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"}, 74 {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"}, 75 {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"}, 76 {ERR_PACK(0, SYS_F_BIND, 0), "bind"}, 77 {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"}, 78 {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"}, 79 # ifdef OPENSSL_SYS_WINDOWS 80 {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"}, 81 # endif 82 {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"}, 83 {ERR_PACK(0, SYS_F_FREAD, 0), "fread"}, 84 {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"}, 85 {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"}, 86 {ERR_PACK(0, SYS_F_SETSOCKOPT, 0), "setsockopt"}, 87 {ERR_PACK(0, SYS_F_GETSOCKOPT, 0), "getsockopt"}, 88 {ERR_PACK(0, SYS_F_GETSOCKNAME, 0), "getsockname"}, 89 {ERR_PACK(0, SYS_F_GETHOSTBYNAME, 0), "gethostbyname"}, 90 {ERR_PACK(0, SYS_F_FFLUSH, 0), "fflush"}, 91 {ERR_PACK(0, SYS_F_OPEN, 0), "open"}, 92 {ERR_PACK(0, SYS_F_CLOSE, 0), "close"}, 93 {ERR_PACK(0, SYS_F_IOCTL, 0), "ioctl"}, 94 {ERR_PACK(0, SYS_F_STAT, 0), "stat"}, 95 {ERR_PACK(0, SYS_F_FCNTL, 0), "fcntl"}, 96 {ERR_PACK(0, SYS_F_FSTAT, 0), "fstat"}, 97 {0, NULL}, 98 }; 99 100 static ERR_STRING_DATA ERR_str_reasons[] = { 101 {ERR_R_SYS_LIB, "system lib"}, 102 {ERR_R_BN_LIB, "BN lib"}, 103 {ERR_R_RSA_LIB, "RSA lib"}, 104 {ERR_R_DH_LIB, "DH lib"}, 105 {ERR_R_EVP_LIB, "EVP lib"}, 106 {ERR_R_BUF_LIB, "BUF lib"}, 107 {ERR_R_OBJ_LIB, "OBJ lib"}, 108 {ERR_R_PEM_LIB, "PEM lib"}, 109 {ERR_R_DSA_LIB, "DSA lib"}, 110 {ERR_R_X509_LIB, "X509 lib"}, 111 {ERR_R_ASN1_LIB, "ASN1 lib"}, 112 {ERR_R_EC_LIB, "EC lib"}, 113 {ERR_R_BIO_LIB, "BIO lib"}, 114 {ERR_R_PKCS7_LIB, "PKCS7 lib"}, 115 {ERR_R_X509V3_LIB, "X509V3 lib"}, 116 {ERR_R_ENGINE_LIB, "ENGINE lib"}, 117 {ERR_R_UI_LIB, "UI lib"}, 118 {ERR_R_OSSL_STORE_LIB, "STORE lib"}, 119 {ERR_R_ECDSA_LIB, "ECDSA lib"}, 120 121 {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"}, 122 {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"}, 123 124 {ERR_R_FATAL, "fatal"}, 125 {ERR_R_MALLOC_FAILURE, "malloc failure"}, 126 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED, 127 "called a function you should not call"}, 128 {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"}, 129 {ERR_R_INTERNAL_ERROR, "internal error"}, 130 {ERR_R_DISABLED, "called a function that was disabled at compile-time"}, 131 {ERR_R_INIT_FAIL, "init fail"}, 132 {ERR_R_OPERATION_FAIL, "operation fail"}, 133 134 {0, NULL}, 135 }; 136 #endif 137 138 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT; 139 static int set_err_thread_local; 140 static CRYPTO_THREAD_LOCAL err_thread_local; 141 142 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT; 143 static CRYPTO_RWLOCK *err_string_lock; 144 145 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *); 146 147 /* 148 * The internal state 149 */ 150 151 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL; 152 static int int_err_library_number = ERR_LIB_USER; 153 154 static unsigned long get_error_values(int inc, int top, const char **file, 155 int *line, const char **data, 156 int *flags); 157 158 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a) 159 { 160 unsigned long ret, l; 161 162 l = a->error; 163 ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l); 164 return (ret ^ ret % 19 * 13); 165 } 166 167 static int err_string_data_cmp(const ERR_STRING_DATA *a, 168 const ERR_STRING_DATA *b) 169 { 170 if (a->error == b->error) 171 return 0; 172 return a->error > b->error ? 1 : -1; 173 } 174 175 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d) 176 { 177 ERR_STRING_DATA *p = NULL; 178 179 CRYPTO_THREAD_read_lock(err_string_lock); 180 p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d); 181 CRYPTO_THREAD_unlock(err_string_lock); 182 183 return p; 184 } 185 186 #ifndef OPENSSL_NO_ERR 187 /* A measurement on Linux 2018-11-21 showed about 3.5kib */ 188 # define SPACE_SYS_STR_REASONS 4 * 1024 189 # define NUM_SYS_STR_REASONS 127 190 191 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1]; 192 /* 193 * SYS_str_reasons is filled with copies of strerror() results at 194 * initialization. 'errno' values up to 127 should cover all usual errors, 195 * others will be displayed numerically by ERR_error_string. It is crucial 196 * that we have something for each reason code that occurs in 197 * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(), 198 * which always gets an errno value and never one of those 'standard' reason 199 * codes. 200 */ 201 202 static void build_SYS_str_reasons(void) 203 { 204 /* OPENSSL_malloc cannot be used here, use static storage instead */ 205 static char strerror_pool[SPACE_SYS_STR_REASONS]; 206 char *cur = strerror_pool; 207 size_t cnt = 0; 208 static int init = 1; 209 int i; 210 int saveerrno = get_last_sys_error(); 211 212 CRYPTO_THREAD_write_lock(err_string_lock); 213 if (!init) { 214 CRYPTO_THREAD_unlock(err_string_lock); 215 return; 216 } 217 218 for (i = 1; i <= NUM_SYS_STR_REASONS; i++) { 219 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1]; 220 221 str->error = ERR_PACK(ERR_LIB_SYS, 0, i); 222 if (str->string == NULL) { 223 if (openssl_strerror_r(i, cur, sizeof(strerror_pool) - cnt)) { 224 size_t l = strlen(cur); 225 226 str->string = cur; 227 cnt += l; 228 if (cnt > sizeof(strerror_pool)) 229 cnt = sizeof(strerror_pool); 230 cur += l; 231 232 /* 233 * VMS has an unusual quirk of adding spaces at the end of 234 * some (most? all?) messages. Lets trim them off. 235 */ 236 while (ossl_isspace(cur[-1])) { 237 cur--; 238 cnt--; 239 } 240 *cur++ = '\0'; 241 cnt++; 242 } 243 } 244 if (str->string == NULL) 245 str->string = "unknown"; 246 } 247 248 /* 249 * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as 250 * required by ERR_load_strings. 251 */ 252 253 init = 0; 254 255 CRYPTO_THREAD_unlock(err_string_lock); 256 /* openssl_strerror_r could change errno, but we want to preserve it */ 257 set_sys_error(saveerrno); 258 err_load_strings(SYS_str_reasons); 259 } 260 #endif 261 262 #define err_clear_data(p, i) \ 263 do { \ 264 if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) {\ 265 OPENSSL_free((p)->err_data[i]); \ 266 (p)->err_data[i] = NULL; \ 267 } \ 268 (p)->err_data_flags[i] = 0; \ 269 } while (0) 270 271 #define err_clear(p, i) \ 272 do { \ 273 err_clear_data(p, i); \ 274 (p)->err_flags[i] = 0; \ 275 (p)->err_buffer[i] = 0; \ 276 (p)->err_file[i] = NULL; \ 277 (p)->err_line[i] = -1; \ 278 } while (0) 279 280 static void ERR_STATE_free(ERR_STATE *s) 281 { 282 int i; 283 284 if (s == NULL) 285 return; 286 for (i = 0; i < ERR_NUM_ERRORS; i++) { 287 err_clear_data(s, i); 288 } 289 OPENSSL_free(s); 290 } 291 292 DEFINE_RUN_ONCE_STATIC(do_err_strings_init) 293 { 294 if (!OPENSSL_init_crypto(0, NULL)) 295 return 0; 296 err_string_lock = CRYPTO_THREAD_lock_new(); 297 if (err_string_lock == NULL) 298 return 0; 299 int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash, 300 err_string_data_cmp); 301 if (int_error_hash == NULL) { 302 CRYPTO_THREAD_lock_free(err_string_lock); 303 err_string_lock = NULL; 304 return 0; 305 } 306 return 1; 307 } 308 309 void err_cleanup(void) 310 { 311 if (set_err_thread_local != 0) 312 CRYPTO_THREAD_cleanup_local(&err_thread_local); 313 CRYPTO_THREAD_lock_free(err_string_lock); 314 err_string_lock = NULL; 315 lh_ERR_STRING_DATA_free(int_error_hash); 316 int_error_hash = NULL; 317 } 318 319 /* 320 * Legacy; pack in the library. 321 */ 322 static void err_patch(int lib, ERR_STRING_DATA *str) 323 { 324 unsigned long plib = ERR_PACK(lib, 0, 0); 325 326 for (; str->error != 0; str++) 327 str->error |= plib; 328 } 329 330 /* 331 * Hash in |str| error strings. Assumes the URN_ONCE was done. 332 */ 333 static int err_load_strings(const ERR_STRING_DATA *str) 334 { 335 CRYPTO_THREAD_write_lock(err_string_lock); 336 for (; str->error; str++) 337 (void)lh_ERR_STRING_DATA_insert(int_error_hash, 338 (ERR_STRING_DATA *)str); 339 CRYPTO_THREAD_unlock(err_string_lock); 340 return 1; 341 } 342 343 int ERR_load_ERR_strings(void) 344 { 345 #ifndef OPENSSL_NO_ERR 346 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) 347 return 0; 348 349 err_load_strings(ERR_str_libraries); 350 err_load_strings(ERR_str_reasons); 351 err_patch(ERR_LIB_SYS, ERR_str_functs); 352 err_load_strings(ERR_str_functs); 353 build_SYS_str_reasons(); 354 #endif 355 return 1; 356 } 357 358 int ERR_load_strings(int lib, ERR_STRING_DATA *str) 359 { 360 if (ERR_load_ERR_strings() == 0) 361 return 0; 362 363 err_patch(lib, str); 364 err_load_strings(str); 365 return 1; 366 } 367 368 int ERR_load_strings_const(const ERR_STRING_DATA *str) 369 { 370 if (ERR_load_ERR_strings() == 0) 371 return 0; 372 err_load_strings(str); 373 return 1; 374 } 375 376 int ERR_unload_strings(int lib, ERR_STRING_DATA *str) 377 { 378 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) 379 return 0; 380 381 CRYPTO_THREAD_write_lock(err_string_lock); 382 /* 383 * We don't need to ERR_PACK the lib, since that was done (to 384 * the table) when it was loaded. 385 */ 386 for (; str->error; str++) 387 (void)lh_ERR_STRING_DATA_delete(int_error_hash, str); 388 CRYPTO_THREAD_unlock(err_string_lock); 389 390 return 1; 391 } 392 393 void err_free_strings_int(void) 394 { 395 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) 396 return; 397 } 398 399 /********************************************************/ 400 401 void ERR_put_error(int lib, int func, int reason, const char *file, int line) 402 { 403 ERR_STATE *es; 404 405 #ifdef _OSD_POSIX 406 /* 407 * In the BS2000-OSD POSIX subsystem, the compiler generates path names 408 * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to 409 * something sensible. @@@ We shouldn't modify a const string, though. 410 */ 411 if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) { 412 char *end; 413 414 /* Skip the "*POSIX(" prefix */ 415 file += sizeof("*POSIX(") - 1; 416 end = &file[strlen(file) - 1]; 417 if (*end == ')') 418 *end = '\0'; 419 /* Optional: use the basename of the path only. */ 420 if ((end = strrchr(file, '/')) != NULL) 421 file = &end[1]; 422 } 423 #endif 424 es = ERR_get_state(); 425 if (es == NULL) 426 return; 427 428 es->top = (es->top + 1) % ERR_NUM_ERRORS; 429 if (es->top == es->bottom) 430 es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS; 431 es->err_flags[es->top] = 0; 432 es->err_buffer[es->top] = ERR_PACK(lib, func, reason); 433 es->err_file[es->top] = file; 434 es->err_line[es->top] = line; 435 err_clear_data(es, es->top); 436 } 437 438 void ERR_clear_error(void) 439 { 440 int i; 441 ERR_STATE *es; 442 443 es = ERR_get_state(); 444 if (es == NULL) 445 return; 446 447 for (i = 0; i < ERR_NUM_ERRORS; i++) { 448 err_clear(es, i); 449 } 450 es->top = es->bottom = 0; 451 } 452 453 unsigned long ERR_get_error(void) 454 { 455 return get_error_values(1, 0, NULL, NULL, NULL, NULL); 456 } 457 458 unsigned long ERR_get_error_line(const char **file, int *line) 459 { 460 return get_error_values(1, 0, file, line, NULL, NULL); 461 } 462 463 unsigned long ERR_get_error_line_data(const char **file, int *line, 464 const char **data, int *flags) 465 { 466 return get_error_values(1, 0, file, line, data, flags); 467 } 468 469 unsigned long ERR_peek_error(void) 470 { 471 return get_error_values(0, 0, NULL, NULL, NULL, NULL); 472 } 473 474 unsigned long ERR_peek_error_line(const char **file, int *line) 475 { 476 return get_error_values(0, 0, file, line, NULL, NULL); 477 } 478 479 unsigned long ERR_peek_error_line_data(const char **file, int *line, 480 const char **data, int *flags) 481 { 482 return get_error_values(0, 0, file, line, data, flags); 483 } 484 485 unsigned long ERR_peek_last_error(void) 486 { 487 return get_error_values(0, 1, NULL, NULL, NULL, NULL); 488 } 489 490 unsigned long ERR_peek_last_error_line(const char **file, int *line) 491 { 492 return get_error_values(0, 1, file, line, NULL, NULL); 493 } 494 495 unsigned long ERR_peek_last_error_line_data(const char **file, int *line, 496 const char **data, int *flags) 497 { 498 return get_error_values(0, 1, file, line, data, flags); 499 } 500 501 static unsigned long get_error_values(int inc, int top, const char **file, 502 int *line, const char **data, 503 int *flags) 504 { 505 int i = 0; 506 ERR_STATE *es; 507 unsigned long ret; 508 509 es = ERR_get_state(); 510 if (es == NULL) 511 return 0; 512 513 if (inc && top) { 514 if (file) 515 *file = ""; 516 if (line) 517 *line = 0; 518 if (data) 519 *data = ""; 520 if (flags) 521 *flags = 0; 522 523 return ERR_R_INTERNAL_ERROR; 524 } 525 526 while (es->bottom != es->top) { 527 if (es->err_flags[es->top] & ERR_FLAG_CLEAR) { 528 err_clear(es, es->top); 529 es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1; 530 continue; 531 } 532 i = (es->bottom + 1) % ERR_NUM_ERRORS; 533 if (es->err_flags[i] & ERR_FLAG_CLEAR) { 534 es->bottom = i; 535 err_clear(es, es->bottom); 536 continue; 537 } 538 break; 539 } 540 541 if (es->bottom == es->top) 542 return 0; 543 544 if (top) 545 i = es->top; /* last error */ 546 else 547 i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */ 548 549 ret = es->err_buffer[i]; 550 if (inc) { 551 es->bottom = i; 552 es->err_buffer[i] = 0; 553 } 554 555 if (file != NULL && line != NULL) { 556 if (es->err_file[i] == NULL) { 557 *file = "NA"; 558 *line = 0; 559 } else { 560 *file = es->err_file[i]; 561 *line = es->err_line[i]; 562 } 563 } 564 565 if (data == NULL) { 566 if (inc) { 567 err_clear_data(es, i); 568 } 569 } else { 570 if (es->err_data[i] == NULL) { 571 *data = ""; 572 if (flags != NULL) 573 *flags = 0; 574 } else { 575 *data = es->err_data[i]; 576 if (flags != NULL) 577 *flags = es->err_data_flags[i]; 578 } 579 } 580 return ret; 581 } 582 583 void ERR_error_string_n(unsigned long e, char *buf, size_t len) 584 { 585 char lsbuf[64], fsbuf[64], rsbuf[64]; 586 const char *ls, *fs, *rs; 587 unsigned long l, f, r; 588 589 if (len == 0) 590 return; 591 592 l = ERR_GET_LIB(e); 593 ls = ERR_lib_error_string(e); 594 if (ls == NULL) { 595 BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l); 596 ls = lsbuf; 597 } 598 599 fs = ERR_func_error_string(e); 600 f = ERR_GET_FUNC(e); 601 if (fs == NULL) { 602 BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f); 603 fs = fsbuf; 604 } 605 606 rs = ERR_reason_error_string(e); 607 r = ERR_GET_REASON(e); 608 if (rs == NULL) { 609 BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r); 610 rs = rsbuf; 611 } 612 613 BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, fs, rs); 614 if (strlen(buf) == len - 1) { 615 /* Didn't fit; use a minimal format. */ 616 BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, f, r); 617 } 618 } 619 620 /* 621 * ERR_error_string_n should be used instead for ret != NULL as 622 * ERR_error_string cannot know how large the buffer is 623 */ 624 char *ERR_error_string(unsigned long e, char *ret) 625 { 626 static char buf[256]; 627 628 if (ret == NULL) 629 ret = buf; 630 ERR_error_string_n(e, ret, (int)sizeof(buf)); 631 return ret; 632 } 633 634 const char *ERR_lib_error_string(unsigned long e) 635 { 636 ERR_STRING_DATA d, *p; 637 unsigned long l; 638 639 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) { 640 return NULL; 641 } 642 643 l = ERR_GET_LIB(e); 644 d.error = ERR_PACK(l, 0, 0); 645 p = int_err_get_item(&d); 646 return ((p == NULL) ? NULL : p->string); 647 } 648 649 const char *ERR_func_error_string(unsigned long e) 650 { 651 ERR_STRING_DATA d, *p; 652 unsigned long l, f; 653 654 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) { 655 return NULL; 656 } 657 658 l = ERR_GET_LIB(e); 659 f = ERR_GET_FUNC(e); 660 d.error = ERR_PACK(l, f, 0); 661 p = int_err_get_item(&d); 662 return ((p == NULL) ? NULL : p->string); 663 } 664 665 const char *ERR_reason_error_string(unsigned long e) 666 { 667 ERR_STRING_DATA d, *p = NULL; 668 unsigned long l, r; 669 670 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) { 671 return NULL; 672 } 673 674 l = ERR_GET_LIB(e); 675 r = ERR_GET_REASON(e); 676 d.error = ERR_PACK(l, 0, r); 677 p = int_err_get_item(&d); 678 if (!p) { 679 d.error = ERR_PACK(0, 0, r); 680 p = int_err_get_item(&d); 681 } 682 return ((p == NULL) ? NULL : p->string); 683 } 684 685 void err_delete_thread_state(void) 686 { 687 ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local); 688 if (state == NULL) 689 return; 690 691 CRYPTO_THREAD_set_local(&err_thread_local, NULL); 692 ERR_STATE_free(state); 693 } 694 695 #if OPENSSL_API_COMPAT < 0x10100000L 696 void ERR_remove_thread_state(void *dummy) 697 { 698 } 699 #endif 700 701 #if OPENSSL_API_COMPAT < 0x10000000L 702 void ERR_remove_state(unsigned long pid) 703 { 704 } 705 #endif 706 707 DEFINE_RUN_ONCE_STATIC(err_do_init) 708 { 709 set_err_thread_local = 1; 710 return CRYPTO_THREAD_init_local(&err_thread_local, NULL); 711 } 712 713 ERR_STATE *ERR_get_state(void) 714 { 715 ERR_STATE *state; 716 int saveerrno = get_last_sys_error(); 717 718 if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL)) 719 return NULL; 720 721 if (!RUN_ONCE(&err_init, err_do_init)) 722 return NULL; 723 724 state = CRYPTO_THREAD_get_local(&err_thread_local); 725 if (state == (ERR_STATE*)-1) 726 return NULL; 727 728 if (state == NULL) { 729 if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1)) 730 return NULL; 731 732 if ((state = OPENSSL_zalloc(sizeof(*state))) == NULL) { 733 CRYPTO_THREAD_set_local(&err_thread_local, NULL); 734 return NULL; 735 } 736 737 if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE) 738 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) { 739 ERR_STATE_free(state); 740 CRYPTO_THREAD_set_local(&err_thread_local, NULL); 741 return NULL; 742 } 743 744 /* Ignore failures from these */ 745 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL); 746 } 747 748 set_sys_error(saveerrno); 749 return state; 750 } 751 752 /* 753 * err_shelve_state returns the current thread local error state 754 * and freezes the error module until err_unshelve_state is called. 755 */ 756 int err_shelve_state(void **state) 757 { 758 int saveerrno = get_last_sys_error(); 759 760 /* 761 * Note, at present our only caller is OPENSSL_init_crypto(), indirectly 762 * via ossl_init_load_crypto_nodelete(), by which point the requested 763 * "base" initialization has already been performed, so the below call is a 764 * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return. 765 * 766 * If are no other valid callers of this function, the call below can be 767 * removed, avoiding the re-entry into OPENSSL_init_crypto(). If there are 768 * potential uses that are not from inside OPENSSL_init_crypto(), then this 769 * call is needed, but some care is required to make sure that the re-entry 770 * remains a NOOP. 771 */ 772 if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL)) 773 return 0; 774 775 if (!RUN_ONCE(&err_init, err_do_init)) 776 return 0; 777 778 *state = CRYPTO_THREAD_get_local(&err_thread_local); 779 if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1)) 780 return 0; 781 782 set_sys_error(saveerrno); 783 return 1; 784 } 785 786 /* 787 * err_unshelve_state restores the error state that was returned 788 * by err_shelve_state previously. 789 */ 790 void err_unshelve_state(void* state) 791 { 792 if (state != (void*)-1) 793 CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)state); 794 } 795 796 int ERR_get_next_error_library(void) 797 { 798 int ret; 799 800 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) 801 return 0; 802 803 CRYPTO_THREAD_write_lock(err_string_lock); 804 ret = int_err_library_number++; 805 CRYPTO_THREAD_unlock(err_string_lock); 806 return ret; 807 } 808 809 static int err_set_error_data_int(char *data, int flags) 810 { 811 ERR_STATE *es; 812 int i; 813 814 es = ERR_get_state(); 815 if (es == NULL) 816 return 0; 817 818 i = es->top; 819 820 err_clear_data(es, i); 821 es->err_data[i] = data; 822 es->err_data_flags[i] = flags; 823 824 return 1; 825 } 826 827 void ERR_set_error_data(char *data, int flags) 828 { 829 /* 830 * This function is void so we cannot propagate the error return. Since it 831 * is also in the public API we can't change the return type. 832 */ 833 err_set_error_data_int(data, flags); 834 } 835 836 void ERR_add_error_data(int num, ...) 837 { 838 va_list args; 839 va_start(args, num); 840 ERR_add_error_vdata(num, args); 841 va_end(args); 842 } 843 844 void ERR_add_error_vdata(int num, va_list args) 845 { 846 int i, n, s; 847 char *str, *p, *a; 848 849 s = 80; 850 if ((str = OPENSSL_malloc(s + 1)) == NULL) { 851 /* ERRerr(ERR_F_ERR_ADD_ERROR_VDATA, ERR_R_MALLOC_FAILURE); */ 852 return; 853 } 854 str[0] = '\0'; 855 856 n = 0; 857 for (i = 0; i < num; i++) { 858 a = va_arg(args, char *); 859 if (a == NULL) 860 a = "<NULL>"; 861 n += strlen(a); 862 if (n > s) { 863 s = n + 20; 864 p = OPENSSL_realloc(str, s + 1); 865 if (p == NULL) { 866 OPENSSL_free(str); 867 return; 868 } 869 str = p; 870 } 871 OPENSSL_strlcat(str, a, (size_t)s + 1); 872 } 873 if (!err_set_error_data_int(str, ERR_TXT_MALLOCED | ERR_TXT_STRING)) 874 OPENSSL_free(str); 875 } 876 877 int ERR_set_mark(void) 878 { 879 ERR_STATE *es; 880 881 es = ERR_get_state(); 882 if (es == NULL) 883 return 0; 884 885 if (es->bottom == es->top) 886 return 0; 887 es->err_flags[es->top] |= ERR_FLAG_MARK; 888 return 1; 889 } 890 891 int ERR_pop_to_mark(void) 892 { 893 ERR_STATE *es; 894 895 es = ERR_get_state(); 896 if (es == NULL) 897 return 0; 898 899 while (es->bottom != es->top 900 && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) { 901 err_clear(es, es->top); 902 es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1; 903 } 904 905 if (es->bottom == es->top) 906 return 0; 907 es->err_flags[es->top] &= ~ERR_FLAG_MARK; 908 return 1; 909 } 910 911 int ERR_clear_last_mark(void) 912 { 913 ERR_STATE *es; 914 int top; 915 916 es = ERR_get_state(); 917 if (es == NULL) 918 return 0; 919 920 top = es->top; 921 while (es->bottom != top 922 && (es->err_flags[top] & ERR_FLAG_MARK) == 0) { 923 top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1; 924 } 925 926 if (es->bottom == top) 927 return 0; 928 es->err_flags[top] &= ~ERR_FLAG_MARK; 929 return 1; 930 } 931 932 void err_clear_last_constant_time(int clear) 933 { 934 ERR_STATE *es; 935 int top; 936 937 es = ERR_get_state(); 938 if (es == NULL) 939 return; 940 941 top = es->top; 942 943 /* 944 * Flag error as cleared but remove it elsewhere to avoid two errors 945 * accessing the same error stack location, revealing timing information. 946 */ 947 clear = constant_time_select_int(constant_time_eq_int(clear, 0), 948 0, ERR_FLAG_CLEAR); 949 es->err_flags[top] |= clear; 950 } 951