2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
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
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"
23 static int err_load_strings(const ERR_STRING_DATA *str);
25 static void ERR_STATE_free(ERR_STATE *s);
26 #ifndef OPENSSL_NO_ERR
27 static ERR_STRING_DATA ERR_str_libraries[] = {
28 {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
29 {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
30 {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
31 {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
32 {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
33 {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
34 {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
35 {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
36 {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
37 {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
38 {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
39 {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
40 {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
41 {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
42 {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
43 {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
44 {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
45 {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
46 {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
47 {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
48 {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
49 {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
50 {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
51 {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
52 {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
53 {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
54 {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
55 {ERR_PACK(ERR_LIB_UI, 0, 0), "UI routines"},
56 {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
57 {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
58 {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
59 {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
60 {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
61 {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"},
62 {ERR_PACK(ERR_LIB_OSSL_STORE, 0, 0), "STORE routines"},
63 {ERR_PACK(ERR_LIB_SM2, 0, 0), "SM2 routines"},
67 static ERR_STRING_DATA ERR_str_functs[] = {
68 {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
69 {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
70 {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
71 {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
72 {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
73 {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
74 {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
75 {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
76 # ifdef OPENSSL_SYS_WINDOWS
77 {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
79 {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
80 {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
81 {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"},
82 {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"},
83 {ERR_PACK(0, SYS_F_SETSOCKOPT, 0), "setsockopt"},
84 {ERR_PACK(0, SYS_F_GETSOCKOPT, 0), "getsockopt"},
85 {ERR_PACK(0, SYS_F_GETSOCKNAME, 0), "getsockname"},
86 {ERR_PACK(0, SYS_F_GETHOSTBYNAME, 0), "gethostbyname"},
87 {ERR_PACK(0, SYS_F_FFLUSH, 0), "fflush"},
88 {ERR_PACK(0, SYS_F_OPEN, 0), "open"},
89 {ERR_PACK(0, SYS_F_CLOSE, 0), "close"},
90 {ERR_PACK(0, SYS_F_IOCTL, 0), "ioctl"},
91 {ERR_PACK(0, SYS_F_STAT, 0), "stat"},
92 {ERR_PACK(0, SYS_F_FCNTL, 0), "fcntl"},
93 {ERR_PACK(0, SYS_F_FSTAT, 0), "fstat"},
97 static ERR_STRING_DATA ERR_str_reasons[] = {
98 {ERR_R_SYS_LIB, "system lib"},
99 {ERR_R_BN_LIB, "BN lib"},
100 {ERR_R_RSA_LIB, "RSA lib"},
101 {ERR_R_DH_LIB, "DH lib"},
102 {ERR_R_EVP_LIB, "EVP lib"},
103 {ERR_R_BUF_LIB, "BUF lib"},
104 {ERR_R_OBJ_LIB, "OBJ lib"},
105 {ERR_R_PEM_LIB, "PEM lib"},
106 {ERR_R_DSA_LIB, "DSA lib"},
107 {ERR_R_X509_LIB, "X509 lib"},
108 {ERR_R_ASN1_LIB, "ASN1 lib"},
109 {ERR_R_EC_LIB, "EC lib"},
110 {ERR_R_BIO_LIB, "BIO lib"},
111 {ERR_R_PKCS7_LIB, "PKCS7 lib"},
112 {ERR_R_X509V3_LIB, "X509V3 lib"},
113 {ERR_R_ENGINE_LIB, "ENGINE lib"},
114 {ERR_R_UI_LIB, "UI lib"},
115 {ERR_R_OSSL_STORE_LIB, "STORE lib"},
116 {ERR_R_ECDSA_LIB, "ECDSA lib"},
118 {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
119 {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
121 {ERR_R_FATAL, "fatal"},
122 {ERR_R_MALLOC_FAILURE, "malloc failure"},
123 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
124 "called a function you should not call"},
125 {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
126 {ERR_R_INTERNAL_ERROR, "internal error"},
127 {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
128 {ERR_R_INIT_FAIL, "init fail"},
129 {ERR_R_OPERATION_FAIL, "operation fail"},
135 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
136 static int set_err_thread_local;
137 static CRYPTO_THREAD_LOCAL err_thread_local;
139 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
140 static CRYPTO_RWLOCK *err_string_lock;
142 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
148 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
149 static int int_err_library_number = ERR_LIB_USER;
151 static unsigned long get_error_values(int inc, int top, const char **file,
152 int *line, const char **data,
155 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
157 unsigned long ret, l;
160 ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
161 return (ret ^ ret % 19 * 13);
164 static int err_string_data_cmp(const ERR_STRING_DATA *a,
165 const ERR_STRING_DATA *b)
167 if (a->error == b->error)
169 return a->error > b->error ? 1 : -1;
172 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
174 ERR_STRING_DATA *p = NULL;
176 CRYPTO_THREAD_read_lock(err_string_lock);
177 p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
178 CRYPTO_THREAD_unlock(err_string_lock);
183 #ifndef OPENSSL_NO_ERR
184 # define NUM_SYS_STR_REASONS 127
185 # define LEN_SYS_STR_REASON 32
187 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
189 * SYS_str_reasons is filled with copies of strerror() results at
190 * initialization. 'errno' values up to 127 should cover all usual errors,
191 * others will be displayed numerically by ERR_error_string. It is crucial
192 * that we have something for each reason code that occurs in
193 * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
194 * which always gets an errno value and never one of those 'standard' reason
198 static void build_SYS_str_reasons(void)
200 /* OPENSSL_malloc cannot be used here, use static storage instead */
201 static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
205 CRYPTO_THREAD_write_lock(err_string_lock);
207 CRYPTO_THREAD_unlock(err_string_lock);
211 for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
212 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
214 str->error = ERR_PACK(ERR_LIB_SYS, 0, i);
215 if (str->string == NULL) {
216 char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
217 if (openssl_strerror_r(i, *dest, sizeof(*dest)))
220 if (str->string == NULL)
221 str->string = "unknown";
225 * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
226 * required by ERR_load_strings.
231 CRYPTO_THREAD_unlock(err_string_lock);
232 err_load_strings(SYS_str_reasons);
236 #define err_clear_data(p,i) \
238 if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
240 OPENSSL_free((p)->err_data[i]); \
241 (p)->err_data[i]=NULL; \
243 (p)->err_data_flags[i]=0; \
246 #define err_clear(p,i) \
248 (p)->err_flags[i]=0; \
249 (p)->err_buffer[i]=0; \
250 err_clear_data(p,i); \
251 (p)->err_file[i]=NULL; \
252 (p)->err_line[i]= -1; \
255 static void ERR_STATE_free(ERR_STATE *s)
262 for (i = 0; i < ERR_NUM_ERRORS; i++) {
263 err_clear_data(s, i);
268 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
270 OPENSSL_init_crypto(0, NULL);
271 err_string_lock = CRYPTO_THREAD_lock_new();
272 int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
273 err_string_data_cmp);
274 return err_string_lock != NULL && int_error_hash != NULL;
277 void err_cleanup(void)
279 if (set_err_thread_local != 0)
280 CRYPTO_THREAD_cleanup_local(&err_thread_local);
281 CRYPTO_THREAD_lock_free(err_string_lock);
282 err_string_lock = NULL;
283 lh_ERR_STRING_DATA_free(int_error_hash);
284 int_error_hash = NULL;
288 * Legacy; pack in the library.
290 static void err_patch(int lib, ERR_STRING_DATA *str)
292 unsigned long plib = ERR_PACK(lib, 0, 0);
294 for (; str->error != 0; str++)
299 * Hash in |str| error strings. Assumes the URN_ONCE was done.
301 static int err_load_strings(const ERR_STRING_DATA *str)
303 CRYPTO_THREAD_write_lock(err_string_lock);
304 for (; str->error; str++)
305 (void)lh_ERR_STRING_DATA_insert(int_error_hash,
306 (ERR_STRING_DATA *)str);
307 CRYPTO_THREAD_unlock(err_string_lock);
311 int ERR_load_ERR_strings(void)
313 #ifndef OPENSSL_NO_ERR
314 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
317 err_load_strings(ERR_str_libraries);
318 err_load_strings(ERR_str_reasons);
319 err_patch(ERR_LIB_SYS, ERR_str_functs);
320 err_load_strings(ERR_str_functs);
321 build_SYS_str_reasons();
326 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
328 if (ERR_load_ERR_strings() == 0)
332 err_load_strings(str);
336 int ERR_load_strings_const(const ERR_STRING_DATA *str)
338 if (ERR_load_ERR_strings() == 0)
340 err_load_strings(str);
344 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
346 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
349 CRYPTO_THREAD_write_lock(err_string_lock);
351 * We don't need to ERR_PACK the lib, since that was done (to
352 * the table) when it was loaded.
354 for (; str->error; str++)
355 (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
356 CRYPTO_THREAD_unlock(err_string_lock);
361 void err_free_strings_int(void)
363 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
367 /********************************************************/
369 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
375 * In the BS2000-OSD POSIX subsystem, the compiler generates path names
376 * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
377 * something sensible. @@@ We shouldn't modify a const string, though.
379 if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
382 /* Skip the "*POSIX(" prefix */
383 file += sizeof("*POSIX(") - 1;
384 end = &file[strlen(file) - 1];
387 /* Optional: use the basename of the path only. */
388 if ((end = strrchr(file, '/')) != NULL)
392 es = ERR_get_state();
396 es->top = (es->top + 1) % ERR_NUM_ERRORS;
397 if (es->top == es->bottom)
398 es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
399 es->err_flags[es->top] = 0;
400 es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
401 es->err_file[es->top] = file;
402 es->err_line[es->top] = line;
403 err_clear_data(es, es->top);
406 void ERR_clear_error(void)
411 es = ERR_get_state();
415 for (i = 0; i < ERR_NUM_ERRORS; i++) {
418 es->top = es->bottom = 0;
421 unsigned long ERR_get_error(void)
423 return get_error_values(1, 0, NULL, NULL, NULL, NULL);
426 unsigned long ERR_get_error_line(const char **file, int *line)
428 return get_error_values(1, 0, file, line, NULL, NULL);
431 unsigned long ERR_get_error_line_data(const char **file, int *line,
432 const char **data, int *flags)
434 return get_error_values(1, 0, file, line, data, flags);
437 unsigned long ERR_peek_error(void)
439 return get_error_values(0, 0, NULL, NULL, NULL, NULL);
442 unsigned long ERR_peek_error_line(const char **file, int *line)
444 return get_error_values(0, 0, file, line, NULL, NULL);
447 unsigned long ERR_peek_error_line_data(const char **file, int *line,
448 const char **data, int *flags)
450 return get_error_values(0, 0, file, line, data, flags);
453 unsigned long ERR_peek_last_error(void)
455 return get_error_values(0, 1, NULL, NULL, NULL, NULL);
458 unsigned long ERR_peek_last_error_line(const char **file, int *line)
460 return get_error_values(0, 1, file, line, NULL, NULL);
463 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
464 const char **data, int *flags)
466 return get_error_values(0, 1, file, line, data, flags);
469 static unsigned long get_error_values(int inc, int top, const char **file,
470 int *line, const char **data,
477 es = ERR_get_state();
491 return ERR_R_INTERNAL_ERROR;
494 if (es->bottom == es->top)
497 i = es->top; /* last error */
499 i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
501 ret = es->err_buffer[i];
504 es->err_buffer[i] = 0;
507 if (file != NULL && line != NULL) {
508 if (es->err_file[i] == NULL) {
512 *file = es->err_file[i];
513 *line = es->err_line[i];
519 err_clear_data(es, i);
522 if (es->err_data[i] == NULL) {
527 *data = es->err_data[i];
529 *flags = es->err_data_flags[i];
535 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
537 char lsbuf[64], fsbuf[64], rsbuf[64];
538 const char *ls, *fs, *rs;
539 unsigned long l, f, r;
545 ls = ERR_lib_error_string(e);
547 BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
551 fs = ERR_func_error_string(e);
554 BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
558 rs = ERR_reason_error_string(e);
559 r = ERR_GET_REASON(e);
561 BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
565 BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, fs, rs);
566 if (strlen(buf) == len - 1) {
567 /* Didn't fit; use a minimal format. */
568 BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, f, r);
573 * ERR_error_string_n should be used instead for ret != NULL as
574 * ERR_error_string cannot know how large the buffer is
576 char *ERR_error_string(unsigned long e, char *ret)
578 static char buf[256];
582 ERR_error_string_n(e, ret, (int)sizeof(buf));
586 const char *ERR_lib_error_string(unsigned long e)
588 ERR_STRING_DATA d, *p;
591 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
596 d.error = ERR_PACK(l, 0, 0);
597 p = int_err_get_item(&d);
598 return ((p == NULL) ? NULL : p->string);
601 const char *ERR_func_error_string(unsigned long e)
603 ERR_STRING_DATA d, *p;
606 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
612 d.error = ERR_PACK(l, f, 0);
613 p = int_err_get_item(&d);
614 return ((p == NULL) ? NULL : p->string);
617 const char *ERR_reason_error_string(unsigned long e)
619 ERR_STRING_DATA d, *p = NULL;
622 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
627 r = ERR_GET_REASON(e);
628 d.error = ERR_PACK(l, 0, r);
629 p = int_err_get_item(&d);
631 d.error = ERR_PACK(0, 0, r);
632 p = int_err_get_item(&d);
634 return ((p == NULL) ? NULL : p->string);
637 void err_delete_thread_state(void)
639 ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
643 CRYPTO_THREAD_set_local(&err_thread_local, NULL);
644 ERR_STATE_free(state);
647 #if OPENSSL_API_COMPAT < 0x10100000L
648 void ERR_remove_thread_state(void *dummy)
653 #if OPENSSL_API_COMPAT < 0x10000000L
654 void ERR_remove_state(unsigned long pid)
659 DEFINE_RUN_ONCE_STATIC(err_do_init)
661 set_err_thread_local = 1;
662 return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
665 ERR_STATE *ERR_get_state(void)
667 ERR_STATE *state = NULL;
669 if (!RUN_ONCE(&err_init, err_do_init))
673 * If base OPENSSL_init_crypto() hasn't been called yet, be sure to call
674 * it now to avoid state to be doubly allocated and thereby leak memory.
675 * Needed on any platform that doesn't define OPENSSL_USE_NODELETE.
677 if (!OPENSSL_init_crypto(0, NULL))
680 state = CRYPTO_THREAD_get_local(&err_thread_local);
683 state = OPENSSL_zalloc(sizeof(*state));
687 if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE)
688 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
689 ERR_STATE_free(state);
693 /* Ignore failures from these */
694 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
700 int ERR_get_next_error_library(void)
704 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
708 CRYPTO_THREAD_write_lock(err_string_lock);
709 ret = int_err_library_number++;
710 CRYPTO_THREAD_unlock(err_string_lock);
714 void ERR_set_error_data(char *data, int flags)
719 es = ERR_get_state();
725 err_clear_data(es, i);
726 es->err_data[i] = data;
727 es->err_data_flags[i] = flags;
730 void ERR_add_error_data(int num, ...)
734 ERR_add_error_vdata(num, args);
738 void ERR_add_error_vdata(int num, va_list args)
744 str = OPENSSL_malloc(s + 1);
750 for (i = 0; i < num; i++) {
751 a = va_arg(args, char *);
757 p = OPENSSL_realloc(str, s + 1);
764 OPENSSL_strlcat(str, a, (size_t)s + 1);
766 ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
769 int ERR_set_mark(void)
773 es = ERR_get_state();
777 if (es->bottom == es->top)
779 es->err_flags[es->top] |= ERR_FLAG_MARK;
783 int ERR_pop_to_mark(void)
787 es = ERR_get_state();
791 while (es->bottom != es->top
792 && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
793 err_clear(es, es->top);
794 es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
797 if (es->bottom == es->top)
799 es->err_flags[es->top] &= ~ERR_FLAG_MARK;
803 int ERR_clear_last_mark(void)
808 es = ERR_get_state();
813 while (es->bottom != top
814 && (es->err_flags[top] & ERR_FLAG_MARK) == 0) {
815 top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
818 if (es->bottom == top)
820 es->err_flags[top] &= ~ERR_FLAG_MARK;