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 "crypto/cryptlib.h" 14#include "internal/err.h" 15#include "crypto/err.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 "crypto/ctype.h" 23#include "internal/constant_time.h" 24#include "e_os.h" 25 26static int err_load_strings(const ERR_STRING_DATA *str); 27 28static void ERR_STATE_free(ERR_STATE *s); 29#ifndef OPENSSL_NO_ERR 30static 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 70static 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 100static 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 138static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT; 139static int set_err_thread_local; 140static CRYPTO_THREAD_LOCAL err_thread_local; 141 142static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT; 143static CRYPTO_RWLOCK *err_string_lock; 144 145static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *); 146 147/* 148 * The internal state 149 */ 150 151static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL; 152static int int_err_library_number = ERR_LIB_USER; 153 154static unsigned long get_error_values(int inc, int top, const char **file, 155 int *line, const char **data, 156 int *flags); 157 158static 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 167static 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 175static 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/* 2019-05-21: Russian and Ukrainian locales on Linux require more than 6,5 kB */ 188# define SPACE_SYS_STR_REASONS 8 * 1024 189# define NUM_SYS_STR_REASONS 127 190 191static 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 202static 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 /* 223 * If we have used up all the space in strerror_pool, 224 * there's no point in calling openssl_strerror_r() 225 */ 226 if (str->string == NULL && cnt < sizeof(strerror_pool)) { 227 if (openssl_strerror_r(i, cur, sizeof(strerror_pool) - cnt)) { 228 size_t l = strlen(cur); 229 230 str->string = cur; 231 cnt += l; 232 cur += l; 233 234 /* 235 * VMS has an unusual quirk of adding spaces at the end of 236 * some (most? all?) messages. Lets trim them off. 237 */ 238 while (cur > strerror_pool && ossl_isspace(cur[-1])) { 239 cur--; 240 cnt--; 241 } 242 *cur++ = '\0'; 243 cnt++; 244 } 245 } 246 if (str->string == NULL) 247 str->string = "unknown"; 248 } 249 250 /* 251 * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as 252 * required by ERR_load_strings. 253 */ 254 255 init = 0; 256 257 CRYPTO_THREAD_unlock(err_string_lock); 258 /* openssl_strerror_r could change errno, but we want to preserve it */ 259 set_sys_error(saveerrno); 260 err_load_strings(SYS_str_reasons); 261} 262#endif 263 264#define err_clear_data(p, i) \ 265 do { \ 266 if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) {\ 267 OPENSSL_free((p)->err_data[i]); \ 268 (p)->err_data[i] = NULL; \ 269 } \ 270 (p)->err_data_flags[i] = 0; \ 271 } while (0) 272 273#define err_clear(p, i) \ 274 do { \ 275 err_clear_data(p, i); \ 276 (p)->err_flags[i] = 0; \ 277 (p)->err_buffer[i] = 0; \ 278 (p)->err_file[i] = NULL; \ 279 (p)->err_line[i] = -1; \ 280 } while (0) 281 282static void ERR_STATE_free(ERR_STATE *s) 283{ 284 int i; 285 286 if (s == NULL) 287 return; 288 for (i = 0; i < ERR_NUM_ERRORS; i++) { 289 err_clear_data(s, i); 290 } 291 OPENSSL_free(s); 292} 293 294DEFINE_RUN_ONCE_STATIC(do_err_strings_init) 295{ 296 if (!OPENSSL_init_crypto(0, NULL)) 297 return 0; 298 err_string_lock = CRYPTO_THREAD_lock_new(); 299 if (err_string_lock == NULL) 300 return 0; 301 int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash, 302 err_string_data_cmp); 303 if (int_error_hash == NULL) { 304 CRYPTO_THREAD_lock_free(err_string_lock); 305 err_string_lock = NULL; 306 return 0; 307 } 308 return 1; 309} 310 311void err_cleanup(void) 312{ 313 if (set_err_thread_local != 0) 314 CRYPTO_THREAD_cleanup_local(&err_thread_local); 315 CRYPTO_THREAD_lock_free(err_string_lock); 316 err_string_lock = NULL; 317 lh_ERR_STRING_DATA_free(int_error_hash); 318 int_error_hash = NULL; 319} 320 321/* 322 * Legacy; pack in the library. 323 */ 324static void err_patch(int lib, ERR_STRING_DATA *str) 325{ 326 unsigned long plib = ERR_PACK(lib, 0, 0); 327 328 for (; str->error != 0; str++) 329 str->error |= plib; 330} 331 332/* 333 * Hash in |str| error strings. Assumes the URN_ONCE was done. 334 */ 335static int err_load_strings(const ERR_STRING_DATA *str) 336{ 337 CRYPTO_THREAD_write_lock(err_string_lock); 338 for (; str->error; str++) 339 (void)lh_ERR_STRING_DATA_insert(int_error_hash, 340 (ERR_STRING_DATA *)str); 341 CRYPTO_THREAD_unlock(err_string_lock); 342 return 1; 343} 344 345int ERR_load_ERR_strings(void) 346{ 347#ifndef OPENSSL_NO_ERR 348 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) 349 return 0; 350 351 err_load_strings(ERR_str_libraries); 352 err_load_strings(ERR_str_reasons); 353 err_patch(ERR_LIB_SYS, ERR_str_functs); 354 err_load_strings(ERR_str_functs); 355 build_SYS_str_reasons(); 356#endif 357 return 1; 358} 359 360int ERR_load_strings(int lib, ERR_STRING_DATA *str) 361{ 362 if (ERR_load_ERR_strings() == 0) 363 return 0; 364 365 err_patch(lib, str); 366 err_load_strings(str); 367 return 1; 368} 369 370int ERR_load_strings_const(const ERR_STRING_DATA *str) 371{ 372 if (ERR_load_ERR_strings() == 0) 373 return 0; 374 err_load_strings(str); 375 return 1; 376} 377 378int ERR_unload_strings(int lib, ERR_STRING_DATA *str) 379{ 380 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) 381 return 0; 382 383 CRYPTO_THREAD_write_lock(err_string_lock); 384 /* 385 * We don't need to ERR_PACK the lib, since that was done (to 386 * the table) when it was loaded. 387 */ 388 for (; str->error; str++) 389 (void)lh_ERR_STRING_DATA_delete(int_error_hash, str); 390 CRYPTO_THREAD_unlock(err_string_lock); 391 392 return 1; 393} 394 395void err_free_strings_int(void) 396{ 397 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) 398 return; 399} 400 401/********************************************************/ 402 403void ERR_put_error(int lib, int func, int reason, const char *file, int line) 404{ 405 ERR_STATE *es; 406 407#ifdef _OSD_POSIX 408 /* 409 * In the BS2000-OSD POSIX subsystem, the compiler generates path names 410 * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to 411 * something sensible. @@@ We shouldn't modify a const string, though. 412 */ 413 if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) { 414 char *end; 415 416 /* Skip the "*POSIX(" prefix */ 417 file += sizeof("*POSIX(") - 1; 418 end = &file[strlen(file) - 1]; 419 if (*end == ')') 420 *end = '\0'; 421 /* Optional: use the basename of the path only. */ 422 if ((end = strrchr(file, '/')) != NULL) 423 file = &end[1]; 424 } 425#endif 426 es = ERR_get_state(); 427 if (es == NULL) 428 return; 429 430 es->top = (es->top + 1) % ERR_NUM_ERRORS; 431 if (es->top == es->bottom) 432 es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS; 433 es->err_flags[es->top] = 0; 434 es->err_buffer[es->top] = ERR_PACK(lib, func, reason); 435 es->err_file[es->top] = file; 436 es->err_line[es->top] = line; 437 err_clear_data(es, es->top); 438} 439 440void ERR_clear_error(void) 441{ 442 int i; 443 ERR_STATE *es; 444 445 es = ERR_get_state(); 446 if (es == NULL) 447 return; 448 449 for (i = 0; i < ERR_NUM_ERRORS; i++) { 450 err_clear(es, i); 451 } 452 es->top = es->bottom = 0; 453} 454 455unsigned long ERR_get_error(void) 456{ 457 return get_error_values(1, 0, NULL, NULL, NULL, NULL); 458} 459 460unsigned long ERR_get_error_line(const char **file, int *line) 461{ 462 return get_error_values(1, 0, file, line, NULL, NULL); 463} 464 465unsigned long ERR_get_error_line_data(const char **file, int *line, 466 const char **data, int *flags) 467{ 468 return get_error_values(1, 0, file, line, data, flags); 469} 470 471unsigned long ERR_peek_error(void) 472{ 473 return get_error_values(0, 0, NULL, NULL, NULL, NULL); 474} 475 476unsigned long ERR_peek_error_line(const char **file, int *line) 477{ 478 return get_error_values(0, 0, file, line, NULL, NULL); 479} 480 481unsigned long ERR_peek_error_line_data(const char **file, int *line, 482 const char **data, int *flags) 483{ 484 return get_error_values(0, 0, file, line, data, flags); 485} 486 487unsigned long ERR_peek_last_error(void) 488{ 489 return get_error_values(0, 1, NULL, NULL, NULL, NULL); 490} 491 492unsigned long ERR_peek_last_error_line(const char **file, int *line) 493{ 494 return get_error_values(0, 1, file, line, NULL, NULL); 495} 496 497unsigned long ERR_peek_last_error_line_data(const char **file, int *line, 498 const char **data, int *flags) 499{ 500 return get_error_values(0, 1, file, line, data, flags); 501} 502 503static unsigned long get_error_values(int inc, int top, const char **file, 504 int *line, const char **data, 505 int *flags) 506{ 507 int i = 0; 508 ERR_STATE *es; 509 unsigned long ret; 510 511 es = ERR_get_state(); 512 if (es == NULL) 513 return 0; 514 515 if (inc && top) { 516 if (file) 517 *file = ""; 518 if (line) 519 *line = 0; 520 if (data) 521 *data = ""; 522 if (flags) 523 *flags = 0; 524 525 return ERR_R_INTERNAL_ERROR; 526 } 527 528 while (es->bottom != es->top) { 529 if (es->err_flags[es->top] & ERR_FLAG_CLEAR) { 530 err_clear(es, es->top); 531 es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1; 532 continue; 533 } 534 i = (es->bottom + 1) % ERR_NUM_ERRORS; 535 if (es->err_flags[i] & ERR_FLAG_CLEAR) { 536 es->bottom = i; 537 err_clear(es, es->bottom); 538 continue; 539 } 540 break; 541 } 542 543 if (es->bottom == es->top) 544 return 0; 545 546 if (top) 547 i = es->top; /* last error */ 548 else 549 i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */ 550 551 ret = es->err_buffer[i]; 552 if (inc) { 553 es->bottom = i; 554 es->err_buffer[i] = 0; 555 } 556 557 if (file != NULL && line != NULL) { 558 if (es->err_file[i] == NULL) { 559 *file = "NA"; 560 *line = 0; 561 } else { 562 *file = es->err_file[i]; 563 *line = es->err_line[i]; 564 } 565 } 566 567 if (data == NULL) { 568 if (inc) { 569 err_clear_data(es, i); 570 } 571 } else { 572 if (es->err_data[i] == NULL) { 573 *data = ""; 574 if (flags != NULL) 575 *flags = 0; 576 } else { 577 *data = es->err_data[i]; 578 if (flags != NULL) 579 *flags = es->err_data_flags[i]; 580 } 581 } 582 return ret; 583} 584 585void ERR_error_string_n(unsigned long e, char *buf, size_t len) 586{ 587 char lsbuf[64], fsbuf[64], rsbuf[64]; 588 const char *ls, *fs, *rs; 589 unsigned long l, f, r; 590 591 if (len == 0) 592 return; 593 594 l = ERR_GET_LIB(e); 595 ls = ERR_lib_error_string(e); 596 if (ls == NULL) { 597 BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l); 598 ls = lsbuf; 599 } 600 601 fs = ERR_func_error_string(e); 602 f = ERR_GET_FUNC(e); 603 if (fs == NULL) { 604 BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f); 605 fs = fsbuf; 606 } 607 608 rs = ERR_reason_error_string(e); 609 r = ERR_GET_REASON(e); 610 if (rs == NULL) { 611 BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r); 612 rs = rsbuf; 613 } 614 615 BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, fs, rs); 616 if (strlen(buf) == len - 1) { 617 /* Didn't fit; use a minimal format. */ 618 BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, f, r); 619 } 620} 621 622/* 623 * ERR_error_string_n should be used instead for ret != NULL as 624 * ERR_error_string cannot know how large the buffer is 625 */ 626char *ERR_error_string(unsigned long e, char *ret) 627{ 628 static char buf[256]; 629 630 if (ret == NULL) 631 ret = buf; 632 ERR_error_string_n(e, ret, (int)sizeof(buf)); 633 return ret; 634} 635 636const char *ERR_lib_error_string(unsigned long e) 637{ 638 ERR_STRING_DATA d, *p; 639 unsigned long l; 640 641 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) { 642 return NULL; 643 } 644 645 l = ERR_GET_LIB(e); 646 d.error = ERR_PACK(l, 0, 0); 647 p = int_err_get_item(&d); 648 return ((p == NULL) ? NULL : p->string); 649} 650 651const char *ERR_func_error_string(unsigned long e) 652{ 653 ERR_STRING_DATA d, *p; 654 unsigned long l, f; 655 656 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) { 657 return NULL; 658 } 659 660 l = ERR_GET_LIB(e); 661 f = ERR_GET_FUNC(e); 662 d.error = ERR_PACK(l, f, 0); 663 p = int_err_get_item(&d); 664 return ((p == NULL) ? NULL : p->string); 665} 666 667const char *ERR_reason_error_string(unsigned long e) 668{ 669 ERR_STRING_DATA d, *p = NULL; 670 unsigned long l, r; 671 672 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) { 673 return NULL; 674 } 675 676 l = ERR_GET_LIB(e); 677 r = ERR_GET_REASON(e); 678 d.error = ERR_PACK(l, 0, r); 679 p = int_err_get_item(&d); 680 if (!p) { 681 d.error = ERR_PACK(0, 0, r); 682 p = int_err_get_item(&d); 683 } 684 return ((p == NULL) ? NULL : p->string); 685} 686 687void err_delete_thread_state(void) 688{ 689 ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local); 690 if (state == NULL) 691 return; 692 693 CRYPTO_THREAD_set_local(&err_thread_local, NULL); 694 ERR_STATE_free(state); 695} 696 697#if OPENSSL_API_COMPAT < 0x10100000L 698void ERR_remove_thread_state(void *dummy) 699{ 700} 701#endif 702 703#if OPENSSL_API_COMPAT < 0x10000000L 704void ERR_remove_state(unsigned long pid) 705{ 706} 707#endif 708 709DEFINE_RUN_ONCE_STATIC(err_do_init) 710{ 711 set_err_thread_local = 1; 712 return CRYPTO_THREAD_init_local(&err_thread_local, NULL); 713} 714 715ERR_STATE *ERR_get_state(void) 716{ 717 ERR_STATE *state; 718 int saveerrno = get_last_sys_error(); 719 720 if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL)) 721 return NULL; 722 723 if (!RUN_ONCE(&err_init, err_do_init)) 724 return NULL; 725 726 state = CRYPTO_THREAD_get_local(&err_thread_local); 727 if (state == (ERR_STATE*)-1) 728 return NULL; 729 730 if (state == NULL) { 731 if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1)) 732 return NULL; 733 734 if ((state = OPENSSL_zalloc(sizeof(*state))) == NULL) { 735 CRYPTO_THREAD_set_local(&err_thread_local, NULL); 736 return NULL; 737 } 738 739 if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE) 740 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) { 741 ERR_STATE_free(state); 742 CRYPTO_THREAD_set_local(&err_thread_local, NULL); 743 return NULL; 744 } 745 746 /* Ignore failures from these */ 747 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL); 748 } 749 750 set_sys_error(saveerrno); 751 return state; 752} 753 754/* 755 * err_shelve_state returns the current thread local error state 756 * and freezes the error module until err_unshelve_state is called. 757 */ 758int err_shelve_state(void **state) 759{ 760 int saveerrno = get_last_sys_error(); 761 762 /* 763 * Note, at present our only caller is OPENSSL_init_crypto(), indirectly 764 * via ossl_init_load_crypto_nodelete(), by which point the requested 765 * "base" initialization has already been performed, so the below call is a 766 * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return. 767 * 768 * If are no other valid callers of this function, the call below can be 769 * removed, avoiding the re-entry into OPENSSL_init_crypto(). If there are 770 * potential uses that are not from inside OPENSSL_init_crypto(), then this 771 * call is needed, but some care is required to make sure that the re-entry 772 * remains a NOOP. 773 */ 774 if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL)) 775 return 0; 776 777 if (!RUN_ONCE(&err_init, err_do_init)) 778 return 0; 779 780 *state = CRYPTO_THREAD_get_local(&err_thread_local); 781 if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1)) 782 return 0; 783 784 set_sys_error(saveerrno); 785 return 1; 786} 787 788/* 789 * err_unshelve_state restores the error state that was returned 790 * by err_shelve_state previously. 791 */ 792void err_unshelve_state(void* state) 793{ 794 if (state != (void*)-1) 795 CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)state); 796} 797 798int ERR_get_next_error_library(void) 799{ 800 int ret; 801 802 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) 803 return 0; 804 805 CRYPTO_THREAD_write_lock(err_string_lock); 806 ret = int_err_library_number++; 807 CRYPTO_THREAD_unlock(err_string_lock); 808 return ret; 809} 810 811static int err_set_error_data_int(char *data, int flags) 812{ 813 ERR_STATE *es; 814 int i; 815 816 es = ERR_get_state(); 817 if (es == NULL) 818 return 0; 819 820 i = es->top; 821 822 err_clear_data(es, i); 823 es->err_data[i] = data; 824 es->err_data_flags[i] = flags; 825 826 return 1; 827} 828 829void ERR_set_error_data(char *data, int flags) 830{ 831 /* 832 * This function is void so we cannot propagate the error return. Since it 833 * is also in the public API we can't change the return type. 834 */ 835 err_set_error_data_int(data, flags); 836} 837 838void ERR_add_error_data(int num, ...) 839{ 840 va_list args; 841 va_start(args, num); 842 ERR_add_error_vdata(num, args); 843 va_end(args); 844} 845 846void ERR_add_error_vdata(int num, va_list args) 847{ 848 int i, n, s; 849 char *str, *p, *a; 850 851 s = 80; 852 if ((str = OPENSSL_malloc(s + 1)) == NULL) { 853 /* ERRerr(ERR_F_ERR_ADD_ERROR_VDATA, ERR_R_MALLOC_FAILURE); */ 854 return; 855 } 856 str[0] = '\0'; 857 858 n = 0; 859 for (i = 0; i < num; i++) { 860 a = va_arg(args, char *); 861 if (a == NULL) 862 a = "<NULL>"; 863 n += strlen(a); 864 if (n > s) { 865 s = n + 20; 866 p = OPENSSL_realloc(str, s + 1); 867 if (p == NULL) { 868 OPENSSL_free(str); 869 return; 870 } 871 str = p; 872 } 873 OPENSSL_strlcat(str, a, (size_t)s + 1); 874 } 875 if (!err_set_error_data_int(str, ERR_TXT_MALLOCED | ERR_TXT_STRING)) 876 OPENSSL_free(str); 877} 878 879int ERR_set_mark(void) 880{ 881 ERR_STATE *es; 882 883 es = ERR_get_state(); 884 if (es == NULL) 885 return 0; 886 887 if (es->bottom == es->top) 888 return 0; 889 es->err_flags[es->top] |= ERR_FLAG_MARK; 890 return 1; 891} 892 893int ERR_pop_to_mark(void) 894{ 895 ERR_STATE *es; 896 897 es = ERR_get_state(); 898 if (es == NULL) 899 return 0; 900 901 while (es->bottom != es->top 902 && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) { 903 err_clear(es, es->top); 904 es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1; 905 } 906 907 if (es->bottom == es->top) 908 return 0; 909 es->err_flags[es->top] &= ~ERR_FLAG_MARK; 910 return 1; 911} 912 913int ERR_clear_last_mark(void) 914{ 915 ERR_STATE *es; 916 int top; 917 918 es = ERR_get_state(); 919 if (es == NULL) 920 return 0; 921 922 top = es->top; 923 while (es->bottom != top 924 && (es->err_flags[top] & ERR_FLAG_MARK) == 0) { 925 top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1; 926 } 927 928 if (es->bottom == top) 929 return 0; 930 es->err_flags[top] &= ~ERR_FLAG_MARK; 931 return 1; 932} 933 934void err_clear_last_constant_time(int clear) 935{ 936 ERR_STATE *es; 937 int top; 938 939 es = ERR_get_state(); 940 if (es == NULL) 941 return; 942 943 top = es->top; 944 945 /* 946 * Flag error as cleared but remove it elsewhere to avoid two errors 947 * accessing the same error stack location, revealing timing information. 948 */ 949 clear = constant_time_select_int(constant_time_eq_int(clear, 0), 950 0, ERR_FLAG_CLEAR); 951 es->err_flags[top] |= clear; 952} 953