2 * Copyright 1995-2016 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/lhash.h>
17 #include <openssl/err.h>
18 #include <openssl/crypto.h>
19 #include <openssl/buffer.h>
20 #include <openssl/bio.h>
21 #include <openssl/opensslconf.h>
22 #include "internal/thread_once.h"
24 static int err_load_strings(const ERR_STRING_DATA *str);
26 static void ERR_STATE_free(ERR_STATE *s);
27 #ifndef OPENSSL_NO_ERR
28 static ERR_STRING_DATA ERR_str_libraries[] = {
29 {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
30 {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
31 {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
32 {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
33 {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
34 {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
35 {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
36 {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
37 {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
38 {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
39 {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
40 {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
41 {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
42 {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
43 {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
44 {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
45 {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
46 {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
47 {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
48 {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
49 {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
50 {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
51 {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
52 {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
53 {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
54 {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
55 {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
56 {ERR_PACK(ERR_LIB_UI, 0, 0), "UI routines"},
57 {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
58 {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
59 {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
60 {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
61 {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
62 {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"},
63 {ERR_PACK(ERR_LIB_OSSL_STORE, 0, 0), "STORE 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"},
96 static ERR_STRING_DATA ERR_str_reasons[] = {
97 {ERR_R_SYS_LIB, "system lib"},
98 {ERR_R_BN_LIB, "BN lib"},
99 {ERR_R_RSA_LIB, "RSA lib"},
100 {ERR_R_DH_LIB, "DH lib"},
101 {ERR_R_EVP_LIB, "EVP lib"},
102 {ERR_R_BUF_LIB, "BUF lib"},
103 {ERR_R_OBJ_LIB, "OBJ lib"},
104 {ERR_R_PEM_LIB, "PEM lib"},
105 {ERR_R_DSA_LIB, "DSA lib"},
106 {ERR_R_X509_LIB, "X509 lib"},
107 {ERR_R_ASN1_LIB, "ASN1 lib"},
108 {ERR_R_EC_LIB, "EC lib"},
109 {ERR_R_BIO_LIB, "BIO lib"},
110 {ERR_R_PKCS7_LIB, "PKCS7 lib"},
111 {ERR_R_X509V3_LIB, "X509V3 lib"},
112 {ERR_R_ENGINE_LIB, "ENGINE lib"},
113 {ERR_R_UI_LIB, "UI lib"},
114 {ERR_R_OSSL_STORE_LIB, "STORE lib"},
115 {ERR_R_ECDSA_LIB, "ECDSA lib"},
117 {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
118 {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
120 {ERR_R_FATAL, "fatal"},
121 {ERR_R_MALLOC_FAILURE, "malloc failure"},
122 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
123 "called a function you should not call"},
124 {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
125 {ERR_R_INTERNAL_ERROR, "internal error"},
126 {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
127 {ERR_R_INIT_FAIL, "init fail"},
128 {ERR_R_OPERATION_FAIL, "operation fail"},
134 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
135 static int set_err_thread_local;
136 static CRYPTO_THREAD_LOCAL err_thread_local;
138 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
139 static CRYPTO_RWLOCK *err_string_lock;
141 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
147 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
148 static int int_err_library_number = ERR_LIB_USER;
150 static unsigned long get_error_values(int inc, int top, const char **file,
151 int *line, const char **data,
154 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
156 unsigned long ret, l;
159 ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
160 return (ret ^ ret % 19 * 13);
163 static int err_string_data_cmp(const ERR_STRING_DATA *a,
164 const ERR_STRING_DATA *b)
166 if (a->error == b->error)
168 return a->error > b->error ? 1 : -1;
171 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
173 ERR_STRING_DATA *p = NULL;
175 CRYPTO_THREAD_read_lock(err_string_lock);
176 p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
177 CRYPTO_THREAD_unlock(err_string_lock);
182 #ifndef OPENSSL_NO_ERR
183 # define NUM_SYS_STR_REASONS 127
184 # define LEN_SYS_STR_REASON 32
186 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
188 * SYS_str_reasons is filled with copies of strerror() results at
189 * initialization. 'errno' values up to 127 should cover all usual errors,
190 * others will be displayed numerically by ERR_error_string. It is crucial
191 * that we have something for each reason code that occurs in
192 * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
193 * which always gets an errno value and never one of those 'standard' reason
197 static void build_SYS_str_reasons(void)
199 /* OPENSSL_malloc cannot be used here, use static storage instead */
200 static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
204 CRYPTO_THREAD_write_lock(err_string_lock);
206 CRYPTO_THREAD_unlock(err_string_lock);
210 for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
211 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
213 str->error = ERR_PACK(ERR_LIB_SYS, 0, i);
214 if (str->string == NULL) {
215 char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
216 if (openssl_strerror_r(i, *dest, sizeof(*dest)))
219 if (str->string == NULL)
220 str->string = "unknown";
224 * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
225 * required by ERR_load_strings.
230 CRYPTO_THREAD_unlock(err_string_lock);
231 err_load_strings(SYS_str_reasons);
235 #define err_clear_data(p,i) \
237 if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
239 OPENSSL_free((p)->err_data[i]); \
240 (p)->err_data[i]=NULL; \
242 (p)->err_data_flags[i]=0; \
245 #define err_clear(p,i) \
247 (p)->err_flags[i]=0; \
248 (p)->err_buffer[i]=0; \
249 err_clear_data(p,i); \
250 (p)->err_file[i]=NULL; \
251 (p)->err_line[i]= -1; \
254 static void ERR_STATE_free(ERR_STATE *s)
261 for (i = 0; i < ERR_NUM_ERRORS; i++) {
262 err_clear_data(s, i);
267 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
269 OPENSSL_init_crypto(0, NULL);
270 err_string_lock = CRYPTO_THREAD_lock_new();
271 int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
272 err_string_data_cmp);
273 return err_string_lock != NULL && int_error_hash != NULL;
276 void err_cleanup(void)
278 if (set_err_thread_local != 0)
279 CRYPTO_THREAD_cleanup_local(&err_thread_local);
280 CRYPTO_THREAD_lock_free(err_string_lock);
281 err_string_lock = NULL;
282 lh_ERR_STRING_DATA_free(int_error_hash);
283 int_error_hash = NULL;
287 * Legacy; pack in the library.
289 static void err_patch(int lib, ERR_STRING_DATA *str)
291 unsigned long plib = ERR_PACK(lib, 0, 0);
293 for (; str->error != 0; str++)
298 * Hash in |str| error strings. Assumes the URN_ONCE was done.
300 static int err_load_strings(const ERR_STRING_DATA *str)
302 CRYPTO_THREAD_write_lock(err_string_lock);
303 for (; str->error; str++)
304 (void)lh_ERR_STRING_DATA_insert(int_error_hash,
305 (ERR_STRING_DATA *)str);
306 CRYPTO_THREAD_unlock(err_string_lock);
310 int ERR_load_ERR_strings(void)
312 #ifndef OPENSSL_NO_ERR
313 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
316 err_load_strings(ERR_str_libraries);
317 err_load_strings(ERR_str_reasons);
318 err_patch(ERR_LIB_SYS, ERR_str_functs);
319 err_load_strings(ERR_str_functs);
320 build_SYS_str_reasons();
325 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
327 if (ERR_load_ERR_strings() == 0)
331 err_load_strings(str);
335 int ERR_load_strings_const(const ERR_STRING_DATA *str)
337 if (ERR_load_ERR_strings() == 0)
339 err_load_strings(str);
343 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
345 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
348 CRYPTO_THREAD_write_lock(err_string_lock);
350 * We don't need to ERR_PACK the lib, since that was done (to
351 * the table) when it was loaded.
353 for (; str->error; str++)
354 (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
355 CRYPTO_THREAD_unlock(err_string_lock);
360 void err_free_strings_int(void)
362 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
366 /********************************************************/
368 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
374 * In the BS2000-OSD POSIX subsystem, the compiler generates path names
375 * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
376 * something sensible. @@@ We shouldn't modify a const string, though.
378 if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
381 /* Skip the "*POSIX(" prefix */
382 file += sizeof("*POSIX(") - 1;
383 end = &file[strlen(file) - 1];
386 /* Optional: use the basename of the path only. */
387 if ((end = strrchr(file, '/')) != NULL)
391 es = ERR_get_state();
395 es->top = (es->top + 1) % ERR_NUM_ERRORS;
396 if (es->top == es->bottom)
397 es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
398 es->err_flags[es->top] = 0;
399 es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
400 es->err_file[es->top] = file;
401 es->err_line[es->top] = line;
402 err_clear_data(es, es->top);
405 void ERR_clear_error(void)
410 es = ERR_get_state();
414 for (i = 0; i < ERR_NUM_ERRORS; i++) {
417 es->top = es->bottom = 0;
420 unsigned long ERR_get_error(void)
422 return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
425 unsigned long ERR_get_error_line(const char **file, int *line)
427 return (get_error_values(1, 0, file, line, NULL, NULL));
430 unsigned long ERR_get_error_line_data(const char **file, int *line,
431 const char **data, int *flags)
433 return (get_error_values(1, 0, file, line, data, flags));
436 unsigned long ERR_peek_error(void)
438 return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
441 unsigned long ERR_peek_error_line(const char **file, int *line)
443 return (get_error_values(0, 0, file, line, NULL, NULL));
446 unsigned long ERR_peek_error_line_data(const char **file, int *line,
447 const char **data, int *flags)
449 return (get_error_values(0, 0, file, line, data, flags));
452 unsigned long ERR_peek_last_error(void)
454 return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
457 unsigned long ERR_peek_last_error_line(const char **file, int *line)
459 return (get_error_values(0, 1, file, line, NULL, NULL));
462 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
463 const char **data, int *flags)
465 return (get_error_values(0, 1, file, line, data, flags));
468 static unsigned long get_error_values(int inc, int top, const char **file,
469 int *line, const char **data,
476 es = ERR_get_state();
490 return ERR_R_INTERNAL_ERROR;
493 if (es->bottom == es->top)
496 i = es->top; /* last error */
498 i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
500 ret = es->err_buffer[i];
503 es->err_buffer[i] = 0;
506 if ((file != NULL) && (line != NULL)) {
507 if (es->err_file[i] == NULL) {
512 *file = es->err_file[i];
514 *line = es->err_line[i];
520 err_clear_data(es, i);
523 if (es->err_data[i] == NULL) {
528 *data = es->err_data[i];
530 *flags = es->err_data_flags[i];
536 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
538 char lsbuf[64], fsbuf[64], rsbuf[64];
539 const char *ls, *fs, *rs;
540 unsigned long l, f, r;
547 r = ERR_GET_REASON(e);
549 ls = ERR_lib_error_string(e);
550 fs = ERR_func_error_string(e);
551 rs = ERR_reason_error_string(e);
554 BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
556 BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
558 BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
560 BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
561 fs ? fs : fsbuf, rs ? rs : rsbuf);
562 if (strlen(buf) == len - 1) {
564 * output may be truncated; make sure we always have 5
565 * colon-separated fields, i.e. 4 colons ...
568 if (len > NUM_COLONS) { /* ... if possible */
572 for (i = 0; i < NUM_COLONS; i++) {
573 char *colon = strchr(s, ':');
574 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
576 * set colon no. i at last possible position (buf[len-1]
577 * is the terminating 0)
579 colon = &buf[len - 1] - NUM_COLONS + i;
589 * ERR_error_string_n should be used instead for ret != NULL as
590 * ERR_error_string cannot know how large the buffer is
592 char *ERR_error_string(unsigned long e, char *ret)
594 static char buf[256];
598 ERR_error_string_n(e, ret, 256);
603 const char *ERR_lib_error_string(unsigned long e)
605 ERR_STRING_DATA d, *p;
608 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
613 d.error = ERR_PACK(l, 0, 0);
614 p = int_err_get_item(&d);
615 return ((p == NULL) ? NULL : p->string);
618 const char *ERR_func_error_string(unsigned long e)
620 ERR_STRING_DATA d, *p;
623 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
629 d.error = ERR_PACK(l, f, 0);
630 p = int_err_get_item(&d);
631 return ((p == NULL) ? NULL : p->string);
634 const char *ERR_reason_error_string(unsigned long e)
636 ERR_STRING_DATA d, *p = NULL;
639 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
644 r = ERR_GET_REASON(e);
645 d.error = ERR_PACK(l, 0, r);
646 p = int_err_get_item(&d);
648 d.error = ERR_PACK(0, 0, r);
649 p = int_err_get_item(&d);
651 return ((p == NULL) ? NULL : p->string);
654 void err_delete_thread_state(void)
656 ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
660 CRYPTO_THREAD_set_local(&err_thread_local, NULL);
661 ERR_STATE_free(state);
664 #if OPENSSL_API_COMPAT < 0x10100000L
665 void ERR_remove_thread_state(void *dummy)
670 #if OPENSSL_API_COMPAT < 0x10000000L
671 void ERR_remove_state(unsigned long pid)
676 DEFINE_RUN_ONCE_STATIC(err_do_init)
678 set_err_thread_local = 1;
679 return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
682 ERR_STATE *ERR_get_state(void)
684 ERR_STATE *state = NULL;
686 if (!RUN_ONCE(&err_init, err_do_init))
689 state = CRYPTO_THREAD_get_local(&err_thread_local);
692 state = OPENSSL_zalloc(sizeof(*state));
696 if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE)
697 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
698 ERR_STATE_free(state);
702 /* Ignore failures from these */
703 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
709 int ERR_get_next_error_library(void)
713 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
717 CRYPTO_THREAD_write_lock(err_string_lock);
718 ret = int_err_library_number++;
719 CRYPTO_THREAD_unlock(err_string_lock);
723 void ERR_set_error_data(char *data, int flags)
728 es = ERR_get_state();
734 err_clear_data(es, i);
735 es->err_data[i] = data;
736 es->err_data_flags[i] = flags;
739 void ERR_add_error_data(int num, ...)
743 ERR_add_error_vdata(num, args);
747 void ERR_add_error_vdata(int num, va_list args)
753 str = OPENSSL_malloc(s + 1);
759 for (i = 0; i < num; i++) {
760 a = va_arg(args, char *);
766 p = OPENSSL_realloc(str, s + 1);
773 OPENSSL_strlcat(str, a, (size_t)s + 1);
775 ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
778 int ERR_set_mark(void)
782 es = ERR_get_state();
786 if (es->bottom == es->top)
788 es->err_flags[es->top] |= ERR_FLAG_MARK;
792 int ERR_pop_to_mark(void)
796 es = ERR_get_state();
800 while (es->bottom != es->top
801 && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
802 err_clear(es, es->top);
803 es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
806 if (es->bottom == es->top)
808 es->err_flags[es->top] &= ~ERR_FLAG_MARK;
812 int ERR_clear_last_mark(void)
817 es = ERR_get_state();
822 while (es->bottom != top
823 && (es->err_flags[top] & ERR_FLAG_MARK) == 0) {
824 top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
827 if (es->bottom == top)
829 es->err_flags[top] &= ~ERR_FLAG_MARK;