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/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 void err_load_strings(int lib, 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"},
65 static ERR_STRING_DATA ERR_str_functs[] = {
66 {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
67 {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
68 {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
69 {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
70 {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
71 {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
72 {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
73 {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
74 # ifdef OPENSSL_SYS_WINDOWS
75 {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
77 {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
78 {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
79 {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"},
80 {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"},
81 {ERR_PACK(0, SYS_F_SETSOCKOPT, 0), "setsockopt"},
82 {ERR_PACK(0, SYS_F_GETSOCKOPT, 0), "getsockopt"},
83 {ERR_PACK(0, SYS_F_GETSOCKNAME, 0), "getsockname"},
84 {ERR_PACK(0, SYS_F_GETHOSTBYNAME, 0), "gethostbyname"},
88 static ERR_STRING_DATA ERR_str_reasons[] = {
89 {ERR_R_SYS_LIB, "system lib"},
90 {ERR_R_BN_LIB, "BN lib"},
91 {ERR_R_RSA_LIB, "RSA lib"},
92 {ERR_R_DH_LIB, "DH lib"},
93 {ERR_R_EVP_LIB, "EVP lib"},
94 {ERR_R_BUF_LIB, "BUF lib"},
95 {ERR_R_OBJ_LIB, "OBJ lib"},
96 {ERR_R_PEM_LIB, "PEM lib"},
97 {ERR_R_DSA_LIB, "DSA lib"},
98 {ERR_R_X509_LIB, "X509 lib"},
99 {ERR_R_ASN1_LIB, "ASN1 lib"},
100 {ERR_R_EC_LIB, "EC lib"},
101 {ERR_R_BIO_LIB, "BIO lib"},
102 {ERR_R_PKCS7_LIB, "PKCS7 lib"},
103 {ERR_R_X509V3_LIB, "X509V3 lib"},
104 {ERR_R_ENGINE_LIB, "ENGINE lib"},
105 {ERR_R_ECDSA_LIB, "ECDSA lib"},
107 {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
108 {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
110 {ERR_R_FATAL, "fatal"},
111 {ERR_R_MALLOC_FAILURE, "malloc failure"},
112 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
113 "called a function you should not call"},
114 {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
115 {ERR_R_INTERNAL_ERROR, "internal error"},
116 {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
117 {ERR_R_INIT_FAIL, "init fail"},
123 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
124 static CRYPTO_THREAD_LOCAL err_thread_local;
126 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
127 static CRYPTO_RWLOCK *err_string_lock;
129 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
135 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
136 static int int_err_library_number = ERR_LIB_USER;
138 static unsigned long get_error_values(int inc, int top, const char **file,
139 int *line, const char **data,
142 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
144 unsigned long ret, l;
147 ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
148 return (ret ^ ret % 19 * 13);
151 static int err_string_data_cmp(const ERR_STRING_DATA *a,
152 const ERR_STRING_DATA *b)
154 return (int)(a->error - b->error);
157 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
159 ERR_STRING_DATA *p = NULL;
161 CRYPTO_THREAD_read_lock(err_string_lock);
162 if (int_error_hash != NULL)
163 p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
164 CRYPTO_THREAD_unlock(err_string_lock);
169 #ifndef OPENSSL_NO_ERR
170 # define NUM_SYS_STR_REASONS 127
171 # define LEN_SYS_STR_REASON 32
173 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
175 * SYS_str_reasons is filled with copies of strerror() results at
176 * initialization. 'errno' values up to 127 should cover all usual errors,
177 * others will be displayed numerically by ERR_error_string. It is crucial
178 * that we have something for each reason code that occurs in
179 * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
180 * which always gets an errno value and never one of those 'standard' reason
184 static void build_SYS_str_reasons(void)
186 /* OPENSSL_malloc cannot be used here, use static storage instead */
187 static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
191 CRYPTO_THREAD_write_lock(err_string_lock);
193 CRYPTO_THREAD_unlock(err_string_lock);
197 for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
198 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
200 str->error = (unsigned long)i;
201 if (str->string == NULL) {
202 char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
203 if (openssl_strerror_r(i, *dest, sizeof(*dest)))
206 if (str->string == NULL)
207 str->string = "unknown";
211 * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
212 * required by ERR_load_strings.
217 CRYPTO_THREAD_unlock(err_string_lock);
221 #define err_clear_data(p,i) \
223 if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
225 OPENSSL_free((p)->err_data[i]); \
226 (p)->err_data[i]=NULL; \
228 (p)->err_data_flags[i]=0; \
231 #define err_clear(p,i) \
233 (p)->err_flags[i]=0; \
234 (p)->err_buffer[i]=0; \
235 err_clear_data(p,i); \
236 (p)->err_file[i]=NULL; \
237 (p)->err_line[i]= -1; \
240 static void ERR_STATE_free(ERR_STATE *s)
247 for (i = 0; i < ERR_NUM_ERRORS; i++) {
248 err_clear_data(s, i);
253 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
255 OPENSSL_init_crypto(0, NULL);
256 err_string_lock = CRYPTO_THREAD_lock_new();
257 return err_string_lock != NULL;
260 void err_cleanup(void)
262 CRYPTO_THREAD_cleanup_local(&err_thread_local);
263 CRYPTO_THREAD_lock_free(err_string_lock);
264 err_string_lock = NULL;
267 int ERR_load_ERR_strings(void)
269 #ifndef OPENSSL_NO_ERR
270 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
273 err_load_strings(0, ERR_str_libraries);
274 err_load_strings(0, ERR_str_reasons);
275 err_load_strings(ERR_LIB_SYS, ERR_str_functs);
276 build_SYS_str_reasons();
277 err_load_strings(ERR_LIB_SYS, SYS_str_reasons);
282 static void err_load_strings(int lib, ERR_STRING_DATA *str)
284 CRYPTO_THREAD_write_lock(err_string_lock);
285 if (int_error_hash == NULL)
286 int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
287 err_string_data_cmp);
288 if (int_error_hash != NULL) {
289 for (; str->error; str++) {
291 str->error |= ERR_PACK(lib, 0, 0);
292 (void)lh_ERR_STRING_DATA_insert(int_error_hash, str);
295 CRYPTO_THREAD_unlock(err_string_lock);
298 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
300 if (ERR_load_ERR_strings() == 0)
302 err_load_strings(lib, str);
306 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
308 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
311 CRYPTO_THREAD_write_lock(err_string_lock);
312 if (int_error_hash != NULL) {
313 for (; str->error; str++) {
315 str->error |= ERR_PACK(lib, 0, 0);
316 (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
319 CRYPTO_THREAD_unlock(err_string_lock);
324 void err_free_strings_int(void)
326 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
329 CRYPTO_THREAD_write_lock(err_string_lock);
330 lh_ERR_STRING_DATA_free(int_error_hash);
331 int_error_hash = NULL;
332 CRYPTO_THREAD_unlock(err_string_lock);
335 /********************************************************/
337 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
343 * In the BS2000-OSD POSIX subsystem, the compiler generates path names
344 * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
345 * something sensible. @@@ We shouldn't modify a const string, though.
347 if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
350 /* Skip the "*POSIX(" prefix */
351 file += sizeof("*POSIX(") - 1;
352 end = &file[strlen(file) - 1];
355 /* Optional: use the basename of the path only. */
356 if ((end = strrchr(file, '/')) != NULL)
360 es = ERR_get_state();
362 es->top = (es->top + 1) % ERR_NUM_ERRORS;
363 if (es->top == es->bottom)
364 es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
365 es->err_flags[es->top] = 0;
366 es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
367 es->err_file[es->top] = file;
368 es->err_line[es->top] = line;
369 err_clear_data(es, es->top);
372 void ERR_clear_error(void)
377 es = ERR_get_state();
379 for (i = 0; i < ERR_NUM_ERRORS; i++) {
382 es->top = es->bottom = 0;
385 unsigned long ERR_get_error(void)
387 return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
390 unsigned long ERR_get_error_line(const char **file, int *line)
392 return (get_error_values(1, 0, file, line, NULL, NULL));
395 unsigned long ERR_get_error_line_data(const char **file, int *line,
396 const char **data, int *flags)
398 return (get_error_values(1, 0, file, line, data, flags));
401 unsigned long ERR_peek_error(void)
403 return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
406 unsigned long ERR_peek_error_line(const char **file, int *line)
408 return (get_error_values(0, 0, file, line, NULL, NULL));
411 unsigned long ERR_peek_error_line_data(const char **file, int *line,
412 const char **data, int *flags)
414 return (get_error_values(0, 0, file, line, data, flags));
417 unsigned long ERR_peek_last_error(void)
419 return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
422 unsigned long ERR_peek_last_error_line(const char **file, int *line)
424 return (get_error_values(0, 1, file, line, NULL, NULL));
427 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
428 const char **data, int *flags)
430 return (get_error_values(0, 1, file, line, data, flags));
433 static unsigned long get_error_values(int inc, int top, const char **file,
434 int *line, const char **data,
441 es = ERR_get_state();
453 return ERR_R_INTERNAL_ERROR;
456 if (es->bottom == es->top)
459 i = es->top; /* last error */
461 i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
463 ret = es->err_buffer[i];
466 es->err_buffer[i] = 0;
469 if ((file != NULL) && (line != NULL)) {
470 if (es->err_file[i] == NULL) {
475 *file = es->err_file[i];
477 *line = es->err_line[i];
483 err_clear_data(es, i);
486 if (es->err_data[i] == NULL) {
491 *data = es->err_data[i];
493 *flags = es->err_data_flags[i];
499 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
501 char lsbuf[64], fsbuf[64], rsbuf[64];
502 const char *ls, *fs, *rs;
503 unsigned long l, f, r;
510 r = ERR_GET_REASON(e);
512 ls = ERR_lib_error_string(e);
513 fs = ERR_func_error_string(e);
514 rs = ERR_reason_error_string(e);
517 BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
519 BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
521 BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
523 BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
524 fs ? fs : fsbuf, rs ? rs : rsbuf);
525 if (strlen(buf) == len - 1) {
527 * output may be truncated; make sure we always have 5
528 * colon-separated fields, i.e. 4 colons ...
531 if (len > NUM_COLONS) { /* ... if possible */
535 for (i = 0; i < NUM_COLONS; i++) {
536 char *colon = strchr(s, ':');
537 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
539 * set colon no. i at last possible position (buf[len-1]
540 * is the terminating 0)
542 colon = &buf[len - 1] - NUM_COLONS + i;
552 * ERR_error_string_n should be used instead for ret != NULL as
553 * ERR_error_string cannot know how large the buffer is
555 char *ERR_error_string(unsigned long e, char *ret)
557 static char buf[256];
561 ERR_error_string_n(e, ret, 256);
566 const char *ERR_lib_error_string(unsigned long e)
568 ERR_STRING_DATA d, *p;
571 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
576 d.error = ERR_PACK(l, 0, 0);
577 p = int_err_get_item(&d);
578 return ((p == NULL) ? NULL : p->string);
581 const char *ERR_func_error_string(unsigned long e)
583 ERR_STRING_DATA d, *p;
586 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
592 d.error = ERR_PACK(l, f, 0);
593 p = int_err_get_item(&d);
594 return ((p == NULL) ? NULL : p->string);
597 const char *ERR_reason_error_string(unsigned long e)
599 ERR_STRING_DATA d, *p = NULL;
602 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
607 r = ERR_GET_REASON(e);
608 d.error = ERR_PACK(l, 0, r);
609 p = int_err_get_item(&d);
611 d.error = ERR_PACK(0, 0, r);
612 p = int_err_get_item(&d);
614 return ((p == NULL) ? NULL : p->string);
617 void err_delete_thread_state(void)
619 ERR_STATE *state = ERR_get_state();
623 CRYPTO_THREAD_set_local(&err_thread_local, NULL);
624 ERR_STATE_free(state);
627 #if OPENSSL_API_COMPAT < 0x10100000L
628 void ERR_remove_thread_state(void *dummy)
633 #if OPENSSL_API_COMPAT < 0x10000000L
634 void ERR_remove_state(unsigned long pid)
639 DEFINE_RUN_ONCE_STATIC(err_do_init)
641 return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
644 ERR_STATE *ERR_get_state(void)
646 ERR_STATE *state = NULL;
648 if (!RUN_ONCE(&err_init, err_do_init))
651 state = CRYPTO_THREAD_get_local(&err_thread_local);
654 state = OPENSSL_zalloc(sizeof(*state));
658 if (!CRYPTO_THREAD_set_local(&err_thread_local, state)) {
659 ERR_STATE_free(state);
663 /* Ignore failures from these */
664 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
665 ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE);
671 int ERR_get_next_error_library(void)
675 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
679 CRYPTO_THREAD_write_lock(err_string_lock);
680 ret = int_err_library_number++;
681 CRYPTO_THREAD_unlock(err_string_lock);
685 void ERR_set_error_data(char *data, int flags)
690 es = ERR_get_state();
694 i = ERR_NUM_ERRORS - 1;
696 err_clear_data(es, i);
697 es->err_data[i] = data;
698 es->err_data_flags[i] = flags;
701 void ERR_add_error_data(int num, ...)
705 ERR_add_error_vdata(num, args);
709 void ERR_add_error_vdata(int num, va_list args)
715 str = OPENSSL_malloc(s + 1);
721 for (i = 0; i < num; i++) {
722 a = va_arg(args, char *);
723 /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
728 p = OPENSSL_realloc(str, s + 1);
735 OPENSSL_strlcat(str, a, (size_t)s + 1);
738 ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
741 int ERR_set_mark(void)
745 es = ERR_get_state();
747 if (es->bottom == es->top)
749 es->err_flags[es->top] |= ERR_FLAG_MARK;
753 int ERR_pop_to_mark(void)
757 es = ERR_get_state();
759 while (es->bottom != es->top
760 && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
761 err_clear(es, es->top);
764 es->top = ERR_NUM_ERRORS - 1;
767 if (es->bottom == es->top)
769 es->err_flags[es->top] &= ~ERR_FLAG_MARK;