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_FIPS, 0, 0), "FIPS routines"},
56 {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
57 {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
58 {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
59 {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
60 {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"},
64 static ERR_STRING_DATA ERR_str_functs[] = {
65 {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
66 {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
67 {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
68 {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
69 {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
70 {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
71 {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
72 {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
73 # ifdef OPENSSL_SYS_WINDOWS
74 {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
76 {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
77 {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
78 {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"},
79 {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"},
80 {ERR_PACK(0, SYS_F_SETSOCKOPT, 0), "setsockopt"},
81 {ERR_PACK(0, SYS_F_GETSOCKOPT, 0), "getsockopt"},
82 {ERR_PACK(0, SYS_F_GETSOCKNAME, 0), "getsockname"},
83 {ERR_PACK(0, SYS_F_GETHOSTBYNAME, 0), "gethostbyname"},
87 static ERR_STRING_DATA ERR_str_reasons[] = {
88 {ERR_R_SYS_LIB, "system lib"},
89 {ERR_R_BN_LIB, "BN lib"},
90 {ERR_R_RSA_LIB, "RSA lib"},
91 {ERR_R_DH_LIB, "DH lib"},
92 {ERR_R_EVP_LIB, "EVP lib"},
93 {ERR_R_BUF_LIB, "BUF lib"},
94 {ERR_R_OBJ_LIB, "OBJ lib"},
95 {ERR_R_PEM_LIB, "PEM lib"},
96 {ERR_R_DSA_LIB, "DSA lib"},
97 {ERR_R_X509_LIB, "X509 lib"},
98 {ERR_R_ASN1_LIB, "ASN1 lib"},
99 {ERR_R_EC_LIB, "EC lib"},
100 {ERR_R_BIO_LIB, "BIO lib"},
101 {ERR_R_PKCS7_LIB, "PKCS7 lib"},
102 {ERR_R_X509V3_LIB, "X509V3 lib"},
103 {ERR_R_ENGINE_LIB, "ENGINE lib"},
104 {ERR_R_ECDSA_LIB, "ECDSA lib"},
106 {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
107 {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
109 {ERR_R_FATAL, "fatal"},
110 {ERR_R_MALLOC_FAILURE, "malloc failure"},
111 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
112 "called a function you should not call"},
113 {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
114 {ERR_R_INTERNAL_ERROR, "internal error"},
115 {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
116 {ERR_R_INIT_FAIL, "init fail"},
122 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
123 static CRYPTO_THREAD_LOCAL err_thread_local;
125 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
126 static CRYPTO_RWLOCK *err_string_lock;
128 /* Predeclarations of the "err_defaults" functions */
129 static LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit);
130 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
136 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
137 static int int_err_library_number = ERR_LIB_USER;
139 static unsigned long get_error_values(int inc, int top, const char **file,
140 int *line, const char **data,
143 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
145 unsigned long ret, l;
148 ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
149 return (ret ^ ret % 19 * 13);
152 static int err_string_data_cmp(const ERR_STRING_DATA *a,
153 const ERR_STRING_DATA *b)
155 return (int)(a->error - b->error);
158 static LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit)
160 LHASH_OF(ERR_STRING_DATA) *ret = NULL;
163 CRYPTO_THREAD_write_lock(err_string_lock);
164 if (!int_error_hash && create) {
165 int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
166 err_string_data_cmp);
168 if (int_error_hash != NULL)
169 ret = int_error_hash;
171 CRYPTO_THREAD_unlock(err_string_lock);
176 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
178 ERR_STRING_DATA *p = NULL;
179 LHASH_OF(ERR_STRING_DATA) *hash;
181 CRYPTO_THREAD_read_lock(err_string_lock);
182 hash = get_hash(0, 0);
184 p = lh_ERR_STRING_DATA_retrieve(hash, d);
185 CRYPTO_THREAD_unlock(err_string_lock);
190 #ifndef OPENSSL_NO_ERR
191 # define NUM_SYS_STR_REASONS 127
192 # define LEN_SYS_STR_REASON 32
194 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
196 * SYS_str_reasons is filled with copies of strerror() results at
197 * initialization. 'errno' values up to 127 should cover all usual errors,
198 * others will be displayed numerically by ERR_error_string. It is crucial
199 * that we have something for each reason code that occurs in
200 * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
201 * which always gets an errno value and never one of those 'standard' reason
205 static void build_SYS_str_reasons(void)
207 /* OPENSSL_malloc cannot be used here, use static storage instead */
208 static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
212 CRYPTO_THREAD_write_lock(err_string_lock);
214 CRYPTO_THREAD_unlock(err_string_lock);
218 for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
219 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
221 str->error = (unsigned long)i;
222 if (str->string == NULL) {
223 char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
224 if (openssl_strerror_r(i, *dest, sizeof(*dest)))
227 if (str->string == NULL)
228 str->string = "unknown";
232 * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
233 * required by ERR_load_strings.
238 CRYPTO_THREAD_unlock(err_string_lock);
242 #define err_clear_data(p,i) \
244 if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
246 OPENSSL_free((p)->err_data[i]); \
247 (p)->err_data[i]=NULL; \
249 (p)->err_data_flags[i]=0; \
252 #define err_clear(p,i) \
254 (p)->err_flags[i]=0; \
255 (p)->err_buffer[i]=0; \
256 err_clear_data(p,i); \
257 (p)->err_file[i]=NULL; \
258 (p)->err_line[i]= -1; \
261 static void ERR_STATE_free(ERR_STATE *s)
268 for (i = 0; i < ERR_NUM_ERRORS; i++) {
269 err_clear_data(s, i);
274 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
276 err_string_lock = CRYPTO_THREAD_lock_new();
277 return err_string_lock != NULL;
280 void err_cleanup(void)
282 CRYPTO_THREAD_lock_free(err_string_lock);
283 err_string_lock = NULL;
286 void ERR_load_ERR_strings(void)
288 #ifndef OPENSSL_NO_ERR
289 RUN_ONCE(&err_string_init, do_err_strings_init);
291 err_load_strings(0, ERR_str_libraries);
292 err_load_strings(0, ERR_str_reasons);
293 err_load_strings(ERR_LIB_SYS, ERR_str_functs);
294 build_SYS_str_reasons();
295 err_load_strings(ERR_LIB_SYS, SYS_str_reasons);
299 static void err_load_strings(int lib, ERR_STRING_DATA *str)
301 LHASH_OF(ERR_STRING_DATA) *hash;
303 CRYPTO_THREAD_write_lock(err_string_lock);
304 hash = get_hash(1, 0);
306 for (; str->error; str++) {
308 str->error |= ERR_PACK(lib, 0, 0);
309 (void)lh_ERR_STRING_DATA_insert(hash, str);
312 CRYPTO_THREAD_unlock(err_string_lock);
315 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
317 ERR_load_ERR_strings();
318 err_load_strings(lib, str);
321 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
323 LHASH_OF(ERR_STRING_DATA) *hash;
325 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
328 CRYPTO_THREAD_write_lock(err_string_lock);
329 hash = get_hash(0, 0);
331 for (; str->error; str++) {
333 str->error |= ERR_PACK(lib, 0, 0);
334 (void)lh_ERR_STRING_DATA_delete(hash, str);
337 CRYPTO_THREAD_unlock(err_string_lock);
342 void err_free_strings_int(void)
344 if (!RUN_ONCE(&err_string_init, do_err_strings_init))
347 CRYPTO_THREAD_write_lock(err_string_lock);
348 lh_ERR_STRING_DATA_free(int_error_hash);
349 int_error_hash = NULL;
350 CRYPTO_THREAD_unlock(err_string_lock);
353 /********************************************************/
355 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
361 * In the BS2000-OSD POSIX subsystem, the compiler generates path names
362 * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
363 * something sensible. @@@ We shouldn't modify a const string, though.
365 if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
368 /* Skip the "*POSIX(" prefix */
369 file += sizeof("*POSIX(") - 1;
370 end = &file[strlen(file) - 1];
373 /* Optional: use the basename of the path only. */
374 if ((end = strrchr(file, '/')) != NULL)
378 es = ERR_get_state();
380 es->top = (es->top + 1) % ERR_NUM_ERRORS;
381 if (es->top == es->bottom)
382 es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
383 es->err_flags[es->top] = 0;
384 es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
385 es->err_file[es->top] = file;
386 es->err_line[es->top] = line;
387 err_clear_data(es, es->top);
390 void ERR_clear_error(void)
395 es = ERR_get_state();
397 for (i = 0; i < ERR_NUM_ERRORS; i++) {
400 es->top = es->bottom = 0;
403 unsigned long ERR_get_error(void)
405 return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
408 unsigned long ERR_get_error_line(const char **file, int *line)
410 return (get_error_values(1, 0, file, line, NULL, NULL));
413 unsigned long ERR_get_error_line_data(const char **file, int *line,
414 const char **data, int *flags)
416 return (get_error_values(1, 0, file, line, data, flags));
419 unsigned long ERR_peek_error(void)
421 return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
424 unsigned long ERR_peek_error_line(const char **file, int *line)
426 return (get_error_values(0, 0, file, line, NULL, NULL));
429 unsigned long ERR_peek_error_line_data(const char **file, int *line,
430 const char **data, int *flags)
432 return (get_error_values(0, 0, file, line, data, flags));
435 unsigned long ERR_peek_last_error(void)
437 return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
440 unsigned long ERR_peek_last_error_line(const char **file, int *line)
442 return (get_error_values(0, 1, file, line, NULL, NULL));
445 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
446 const char **data, int *flags)
448 return (get_error_values(0, 1, file, line, data, flags));
451 static unsigned long get_error_values(int inc, int top, const char **file,
452 int *line, const char **data,
459 es = ERR_get_state();
471 return ERR_R_INTERNAL_ERROR;
474 if (es->bottom == es->top)
477 i = es->top; /* last error */
479 i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
481 ret = es->err_buffer[i];
484 es->err_buffer[i] = 0;
487 if ((file != NULL) && (line != NULL)) {
488 if (es->err_file[i] == NULL) {
493 *file = es->err_file[i];
495 *line = es->err_line[i];
501 err_clear_data(es, i);
504 if (es->err_data[i] == NULL) {
509 *data = es->err_data[i];
511 *flags = es->err_data_flags[i];
517 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
519 char lsbuf[64], fsbuf[64], rsbuf[64];
520 const char *ls, *fs, *rs;
521 unsigned long l, f, r;
525 r = ERR_GET_REASON(e);
527 ls = ERR_lib_error_string(e);
528 fs = ERR_func_error_string(e);
529 rs = ERR_reason_error_string(e);
532 BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
534 BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
536 BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
538 BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
539 fs ? fs : fsbuf, rs ? rs : rsbuf);
540 if (strlen(buf) == len - 1) {
542 * output may be truncated; make sure we always have 5
543 * colon-separated fields, i.e. 4 colons ...
546 if (len > NUM_COLONS) { /* ... if possible */
550 for (i = 0; i < NUM_COLONS; i++) {
551 char *colon = strchr(s, ':');
552 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
554 * set colon no. i at last possible position (buf[len-1]
555 * is the terminating 0)
557 colon = &buf[len - 1] - NUM_COLONS + i;
567 * ERR_error_string_n should be used instead for ret != NULL as
568 * ERR_error_string cannot know how large the buffer is
570 char *ERR_error_string(unsigned long e, char *ret)
572 static char buf[256];
576 ERR_error_string_n(e, ret, 256);
581 LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void)
583 return get_hash(0, 1);
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 = ERR_get_state();
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 return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
664 ERR_STATE *ERR_get_state(void)
666 ERR_STATE *state = NULL;
668 if (!RUN_ONCE(&err_init, err_do_init))
671 state = CRYPTO_THREAD_get_local(&err_thread_local);
674 state = OPENSSL_zalloc(sizeof(*state));
678 if (!CRYPTO_THREAD_set_local(&err_thread_local, state)) {
679 ERR_STATE_free(state);
683 /* Ignore failures from these */
684 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
685 ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE);
691 int ERR_get_next_error_library(void)
695 if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
699 CRYPTO_THREAD_write_lock(err_string_lock);
700 ret = int_err_library_number++;
701 CRYPTO_THREAD_unlock(err_string_lock);
705 void ERR_set_error_data(char *data, int flags)
710 es = ERR_get_state();
714 i = ERR_NUM_ERRORS - 1;
716 err_clear_data(es, i);
717 es->err_data[i] = data;
718 es->err_data_flags[i] = flags;
721 void ERR_add_error_data(int num, ...)
725 ERR_add_error_vdata(num, args);
729 void ERR_add_error_vdata(int num, va_list args)
735 str = OPENSSL_malloc(s + 1);
741 for (i = 0; i < num; i++) {
742 a = va_arg(args, char *);
743 /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
748 p = OPENSSL_realloc(str, s + 1);
755 OPENSSL_strlcat(str, a, (size_t)s + 1);
758 ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
761 int ERR_set_mark(void)
765 es = ERR_get_state();
767 if (es->bottom == es->top)
769 es->err_flags[es->top] |= ERR_FLAG_MARK;
773 int ERR_pop_to_mark(void)
777 es = ERR_get_state();
779 while (es->bottom != es->top
780 && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
781 err_clear(es, es->top);
784 es->top = ERR_NUM_ERRORS - 1;
787 if (es->bottom == es->top)
789 es->err_flags[es->top] &= ~ERR_FLAG_MARK;