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"},
94 static ERR_STRING_DATA ERR_str_reasons[] = {
95 {ERR_R_SYS_LIB, "system lib"},
96 {ERR_R_BN_LIB, "BN lib"},
97 {ERR_R_RSA_LIB, "RSA lib"},
98 {ERR_R_DH_LIB, "DH lib"},
99 {ERR_R_EVP_LIB, "EVP lib"},
100 {ERR_R_BUF_LIB, "BUF lib"},
101 {ERR_R_OBJ_LIB, "OBJ lib"},
102 {ERR_R_PEM_LIB, "PEM lib"},
103 {ERR_R_DSA_LIB, "DSA lib"},
104 {ERR_R_X509_LIB, "X509 lib"},
105 {ERR_R_ASN1_LIB, "ASN1 lib"},
106 {ERR_R_EC_LIB, "EC lib"},
107 {ERR_R_BIO_LIB, "BIO lib"},
108 {ERR_R_PKCS7_LIB, "PKCS7 lib"},
109 {ERR_R_X509V3_LIB, "X509V3 lib"},
110 {ERR_R_ENGINE_LIB, "ENGINE lib"},
111 {ERR_R_UI_LIB, "UI lib"},
112 {ERR_R_OSSL_STORE_LIB, "STORE lib"},
113 {ERR_R_ECDSA_LIB, "ECDSA lib"},
115 {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
116 {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
118 {ERR_R_FATAL, "fatal"},
119 {ERR_R_MALLOC_FAILURE, "malloc failure"},
120 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
121 "called a function you should not call"},
122 {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
123 {ERR_R_INTERNAL_ERROR, "internal error"},
124 {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
125 {ERR_R_INIT_FAIL, "init fail"},
126 {ERR_R_OPERATION_FAIL, "operation fail"},
132 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
133 static int set_err_thread_local;
134 static CRYPTO_THREAD_LOCAL err_thread_local;
136 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
137 static CRYPTO_RWLOCK *err_string_lock;
139 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
145 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
146 static int int_err_library_number = ERR_LIB_USER;
148 static unsigned long get_error_values(int inc, int top, const char **file,
149 int *line, const char **data,
152 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
154 unsigned long ret, l;
157 ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
158 return (ret ^ ret % 19 * 13);
161 static int err_string_data_cmp(const ERR_STRING_DATA *a,
162 const ERR_STRING_DATA *b)
164 return (int)(a->error - b->error);
167 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
169 ERR_STRING_DATA *p = NULL;
171 CRYPTO_THREAD_read_lock(err_string_lock);
172 p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
173 CRYPTO_THREAD_unlock(err_string_lock);
178 #ifndef OPENSSL_NO_ERR
179 # define NUM_SYS_STR_REASONS 127
180 # define LEN_SYS_STR_REASON 32
182 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
184 * SYS_str_reasons is filled with copies of strerror() results at
185 * initialization. 'errno' values up to 127 should cover all usual errors,
186 * others will be displayed numerically by ERR_error_string. It is crucial
187 * that we have something for each reason code that occurs in
188 * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
189 * which always gets an errno value and never one of those 'standard' reason
193 static void build_SYS_str_reasons(void)
195 /* OPENSSL_malloc cannot be used here, use static storage instead */
196 static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
200 CRYPTO_THREAD_write_lock(err_string_lock);
202 CRYPTO_THREAD_unlock(err_string_lock);
206 for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
207 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
209 str->error = ERR_PACK(ERR_LIB_SYS, 0, i);
210 if (str->string == NULL) {
211 char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
212 if (openssl_strerror_r(i, *dest, sizeof(*dest)))
215 if (str->string == NULL)
216 str->string = "unknown";
220 * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
221 * required by ERR_load_strings.
226 CRYPTO_THREAD_unlock(err_string_lock);
227 err_load_strings(SYS_str_reasons);
231 #define err_clear_data(p,i) \
233 if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
235 OPENSSL_free((p)->err_data[i]); \
236 (p)->err_data[i]=NULL; \
238 (p)->err_data_flags[i]=0; \
241 #define err_clear(p,i) \
243 (p)->err_flags[i]=0; \
244 (p)->err_buffer[i]=0; \
245 err_clear_data(p,i); \
246 (p)->err_file[i]=NULL; \
247 (p)->err_line[i]= -1; \
250 static void ERR_STATE_free(ERR_STATE *s)
257 for (i = 0; i < ERR_NUM_ERRORS; i++) {
258 err_clear_data(s, i);
263 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
265 OPENSSL_init_crypto(0, NULL);
266 err_string_lock = CRYPTO_THREAD_lock_new();
267 int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
268 err_string_data_cmp);
269 return err_string_lock != NULL && int_error_hash != NULL;
272 void err_cleanup(void)
274 if (set_err_thread_local != 0)
275 CRYPTO_THREAD_cleanup_local(&err_thread_local);
276 CRYPTO_THREAD_lock_free(err_string_lock);
277 err_string_lock = NULL;
278 lh_ERR_STRING_DATA_free(int_error_hash);
279 int_error_hash = NULL;
283 * Legacy; pack in the library.
285 static void err_patch(int lib, ERR_STRING_DATA *str)
287 unsigned long plib = ERR_PACK(lib, 0, 0);
289 for (; str->error != 0; str++)
294 * Hash in |str| error strings. Assumes the URN_ONCE was done.
296 static int err_load_strings(const ERR_STRING_DATA *str)
298 CRYPTO_THREAD_write_lock(err_string_lock);
299 for (; str->error; str++)
300 (void)lh_ERR_STRING_DATA_insert(int_error_hash,
301 (ERR_STRING_DATA *)str);
302 CRYPTO_THREAD_unlock(err_string_lock);
306 int ERR_load_ERR_strings(void)
308 #ifndef OPENSSL_NO_ERR
309 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
312 err_load_strings(ERR_str_libraries);
313 err_load_strings(ERR_str_reasons);
314 err_patch(ERR_LIB_SYS, ERR_str_functs);
315 err_load_strings(ERR_str_functs);
316 build_SYS_str_reasons();
321 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
323 if (ERR_load_ERR_strings() == 0)
327 err_load_strings(str);
331 int ERR_load_strings_const(const ERR_STRING_DATA *str)
333 if (ERR_load_ERR_strings() == 0)
335 err_load_strings(str);
339 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
341 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
344 CRYPTO_THREAD_write_lock(err_string_lock);
346 * We don't need to ERR_PACK the lib, since that was done (to
347 * the table) when it was loaded.
349 for (; str->error; str++)
350 (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
351 CRYPTO_THREAD_unlock(err_string_lock);
356 void err_free_strings_int(void)
358 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
362 /********************************************************/
364 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
370 * In the BS2000-OSD POSIX subsystem, the compiler generates path names
371 * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
372 * something sensible. @@@ We shouldn't modify a const string, though.
374 if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
377 /* Skip the "*POSIX(" prefix */
378 file += sizeof("*POSIX(") - 1;
379 end = &file[strlen(file) - 1];
382 /* Optional: use the basename of the path only. */
383 if ((end = strrchr(file, '/')) != NULL)
387 es = ERR_get_state();
391 es->top = (es->top + 1) % ERR_NUM_ERRORS;
392 if (es->top == es->bottom)
393 es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
394 es->err_flags[es->top] = 0;
395 es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
396 es->err_file[es->top] = file;
397 es->err_line[es->top] = line;
398 err_clear_data(es, es->top);
401 void ERR_clear_error(void)
406 es = ERR_get_state();
410 for (i = 0; i < ERR_NUM_ERRORS; i++) {
413 es->top = es->bottom = 0;
416 unsigned long ERR_get_error(void)
418 return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
421 unsigned long ERR_get_error_line(const char **file, int *line)
423 return (get_error_values(1, 0, file, line, NULL, NULL));
426 unsigned long ERR_get_error_line_data(const char **file, int *line,
427 const char **data, int *flags)
429 return (get_error_values(1, 0, file, line, data, flags));
432 unsigned long ERR_peek_error(void)
434 return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
437 unsigned long ERR_peek_error_line(const char **file, int *line)
439 return (get_error_values(0, 0, file, line, NULL, NULL));
442 unsigned long ERR_peek_error_line_data(const char **file, int *line,
443 const char **data, int *flags)
445 return (get_error_values(0, 0, file, line, data, flags));
448 unsigned long ERR_peek_last_error(void)
450 return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
453 unsigned long ERR_peek_last_error_line(const char **file, int *line)
455 return (get_error_values(0, 1, file, line, NULL, NULL));
458 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
459 const char **data, int *flags)
461 return (get_error_values(0, 1, file, line, data, flags));
464 static unsigned long get_error_values(int inc, int top, const char **file,
465 int *line, const char **data,
472 es = ERR_get_state();
486 return ERR_R_INTERNAL_ERROR;
489 if (es->bottom == es->top)
492 i = es->top; /* last error */
494 i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
496 ret = es->err_buffer[i];
499 es->err_buffer[i] = 0;
502 if ((file != NULL) && (line != NULL)) {
503 if (es->err_file[i] == NULL) {
508 *file = es->err_file[i];
510 *line = es->err_line[i];
516 err_clear_data(es, i);
519 if (es->err_data[i] == NULL) {
524 *data = es->err_data[i];
526 *flags = es->err_data_flags[i];
532 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
534 char lsbuf[64], fsbuf[64], rsbuf[64];
535 const char *ls, *fs, *rs;
536 unsigned long l, f, r;
543 r = ERR_GET_REASON(e);
545 ls = ERR_lib_error_string(e);
546 fs = ERR_func_error_string(e);
547 rs = ERR_reason_error_string(e);
550 BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
552 BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
554 BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
556 BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
557 fs ? fs : fsbuf, rs ? rs : rsbuf);
558 if (strlen(buf) == len - 1) {
560 * output may be truncated; make sure we always have 5
561 * colon-separated fields, i.e. 4 colons ...
564 if (len > NUM_COLONS) { /* ... if possible */
568 for (i = 0; i < NUM_COLONS; i++) {
569 char *colon = strchr(s, ':');
570 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
572 * set colon no. i at last possible position (buf[len-1]
573 * is the terminating 0)
575 colon = &buf[len - 1] - NUM_COLONS + i;
585 * ERR_error_string_n should be used instead for ret != NULL as
586 * ERR_error_string cannot know how large the buffer is
588 char *ERR_error_string(unsigned long e, char *ret)
590 static char buf[256];
594 ERR_error_string_n(e, ret, 256);
599 const char *ERR_lib_error_string(unsigned long e)
601 ERR_STRING_DATA d, *p;
604 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
609 d.error = ERR_PACK(l, 0, 0);
610 p = int_err_get_item(&d);
611 return ((p == NULL) ? NULL : p->string);
614 const char *ERR_func_error_string(unsigned long e)
616 ERR_STRING_DATA d, *p;
619 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
625 d.error = ERR_PACK(l, f, 0);
626 p = int_err_get_item(&d);
627 return ((p == NULL) ? NULL : p->string);
630 const char *ERR_reason_error_string(unsigned long e)
632 ERR_STRING_DATA d, *p = NULL;
635 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
640 r = ERR_GET_REASON(e);
641 d.error = ERR_PACK(l, 0, r);
642 p = int_err_get_item(&d);
644 d.error = ERR_PACK(0, 0, r);
645 p = int_err_get_item(&d);
647 return ((p == NULL) ? NULL : p->string);
650 void err_delete_thread_state(void)
652 ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
656 CRYPTO_THREAD_set_local(&err_thread_local, NULL);
657 ERR_STATE_free(state);
660 #if OPENSSL_API_COMPAT < 0x10100000L
661 void ERR_remove_thread_state(void *dummy)
666 #if OPENSSL_API_COMPAT < 0x10000000L
667 void ERR_remove_state(unsigned long pid)
672 DEFINE_RUN_ONCE_STATIC(err_do_init)
674 set_err_thread_local = 1;
675 return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
678 ERR_STATE *ERR_get_state(void)
680 ERR_STATE *state = NULL;
682 if (!RUN_ONCE(&err_init, err_do_init))
685 state = CRYPTO_THREAD_get_local(&err_thread_local);
688 state = OPENSSL_zalloc(sizeof(*state));
692 if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE)
693 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
694 ERR_STATE_free(state);
698 /* Ignore failures from these */
699 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
705 int ERR_get_next_error_library(void)
709 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
713 CRYPTO_THREAD_write_lock(err_string_lock);
714 ret = int_err_library_number++;
715 CRYPTO_THREAD_unlock(err_string_lock);
719 void ERR_set_error_data(char *data, int flags)
724 es = ERR_get_state();
730 i = ERR_NUM_ERRORS - 1;
732 err_clear_data(es, i);
733 es->err_data[i] = data;
734 es->err_data_flags[i] = flags;
737 void ERR_add_error_data(int num, ...)
741 ERR_add_error_vdata(num, args);
745 void ERR_add_error_vdata(int num, va_list args)
751 str = OPENSSL_malloc(s + 1);
757 for (i = 0; i < num; i++) {
758 a = va_arg(args, char *);
759 /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
764 p = OPENSSL_realloc(str, s + 1);
771 OPENSSL_strlcat(str, a, (size_t)s + 1);
774 ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
777 int ERR_set_mark(void)
781 es = ERR_get_state();
785 if (es->bottom == es->top)
787 es->err_flags[es->top] |= ERR_FLAG_MARK;
791 int ERR_pop_to_mark(void)
795 es = ERR_get_state();
799 while (es->bottom != es->top
800 && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
801 err_clear(es, es->top);
804 es->top = ERR_NUM_ERRORS - 1;
807 if (es->bottom == es->top)
809 es->err_flags[es->top] &= ~ERR_FLAG_MARK;