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>
22 static void err_load_strings(int lib, ERR_STRING_DATA *str);
24 static void ERR_STATE_free(ERR_STATE *s);
25 #ifndef OPENSSL_NO_ERR
26 static ERR_STRING_DATA ERR_str_libraries[] = {
27 {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
28 {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
29 {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
30 {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
31 {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
32 {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
33 {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
34 {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
35 {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
36 {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
37 {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
38 {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
39 {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
40 {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
41 {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
42 {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
43 {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
44 {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
45 {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
46 {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
47 {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
48 {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
49 {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
50 {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
51 {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
52 {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
53 {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
54 {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
55 {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
56 {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
57 {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
58 {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
59 {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"},
63 static ERR_STRING_DATA ERR_str_functs[] = {
64 {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
65 {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
66 {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
67 {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
68 {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
69 {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
70 {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
71 {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
72 # ifdef OPENSSL_SYS_WINDOWS
73 {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
75 {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
76 {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
77 {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"},
78 {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"},
79 {ERR_PACK(0, SYS_F_SETSOCKOPT, 0), "setsockopt"},
80 {ERR_PACK(0, SYS_F_GETSOCKOPT, 0), "getsockopt"},
81 {ERR_PACK(0, SYS_F_GETSOCKNAME, 0), "getsockname"},
82 {ERR_PACK(0, SYS_F_GETHOSTBYNAME, 0), "gethostbyname"},
86 static ERR_STRING_DATA ERR_str_reasons[] = {
87 {ERR_R_SYS_LIB, "system lib"},
88 {ERR_R_BN_LIB, "BN lib"},
89 {ERR_R_RSA_LIB, "RSA lib"},
90 {ERR_R_DH_LIB, "DH lib"},
91 {ERR_R_EVP_LIB, "EVP lib"},
92 {ERR_R_BUF_LIB, "BUF lib"},
93 {ERR_R_OBJ_LIB, "OBJ lib"},
94 {ERR_R_PEM_LIB, "PEM lib"},
95 {ERR_R_DSA_LIB, "DSA lib"},
96 {ERR_R_X509_LIB, "X509 lib"},
97 {ERR_R_ASN1_LIB, "ASN1 lib"},
98 {ERR_R_EC_LIB, "EC lib"},
99 {ERR_R_BIO_LIB, "BIO lib"},
100 {ERR_R_PKCS7_LIB, "PKCS7 lib"},
101 {ERR_R_X509V3_LIB, "X509V3 lib"},
102 {ERR_R_ENGINE_LIB, "ENGINE lib"},
103 {ERR_R_ECDSA_LIB, "ECDSA lib"},
105 {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
106 {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
108 {ERR_R_FATAL, "fatal"},
109 {ERR_R_MALLOC_FAILURE, "malloc failure"},
110 {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
111 "called a function you should not call"},
112 {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
113 {ERR_R_INTERNAL_ERROR, "internal error"},
114 {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
115 {ERR_R_INIT_FAIL, "init fail"},
121 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
122 static CRYPTO_THREAD_LOCAL err_thread_local;
124 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
125 static CRYPTO_RWLOCK *err_string_lock;
127 /* Predeclarations of the "err_defaults" functions */
128 static LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit);
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 LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit)
159 LHASH_OF(ERR_STRING_DATA) *ret = NULL;
162 CRYPTO_THREAD_write_lock(err_string_lock);
163 if (!int_error_hash && create) {
164 int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
165 err_string_data_cmp);
167 if (int_error_hash != NULL)
168 ret = int_error_hash;
170 CRYPTO_THREAD_unlock(err_string_lock);
175 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
177 ERR_STRING_DATA *p = NULL;
178 LHASH_OF(ERR_STRING_DATA) *hash;
180 CRYPTO_THREAD_read_lock(err_string_lock);
181 hash = get_hash(0, 0);
183 p = lh_ERR_STRING_DATA_retrieve(hash, d);
184 CRYPTO_THREAD_unlock(err_string_lock);
189 #ifndef OPENSSL_NO_ERR
190 # define NUM_SYS_STR_REASONS 127
191 # define LEN_SYS_STR_REASON 32
193 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
195 * SYS_str_reasons is filled with copies of strerror() results at
196 * initialization. 'errno' values up to 127 should cover all usual errors,
197 * others will be displayed numerically by ERR_error_string. It is crucial
198 * that we have something for each reason code that occurs in
199 * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
200 * which always gets an errno value and never one of those 'standard' reason
204 static void build_SYS_str_reasons(void)
206 /* OPENSSL_malloc cannot be used here, use static storage instead */
207 static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
211 CRYPTO_THREAD_write_lock(err_string_lock);
213 CRYPTO_THREAD_unlock(err_string_lock);
217 for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
218 ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
220 str->error = (unsigned long)i;
221 if (str->string == NULL) {
222 char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
223 if (openssl_strerror_r(i, *dest, sizeof(*dest)))
226 if (str->string == NULL)
227 str->string = "unknown";
231 * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
232 * required by ERR_load_strings.
237 CRYPTO_THREAD_unlock(err_string_lock);
241 #define err_clear_data(p,i) \
243 if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
245 OPENSSL_free((p)->err_data[i]); \
246 (p)->err_data[i]=NULL; \
248 (p)->err_data_flags[i]=0; \
251 #define err_clear(p,i) \
253 (p)->err_flags[i]=0; \
254 (p)->err_buffer[i]=0; \
255 err_clear_data(p,i); \
256 (p)->err_file[i]=NULL; \
257 (p)->err_line[i]= -1; \
260 static void ERR_STATE_free(ERR_STATE *s)
267 for (i = 0; i < ERR_NUM_ERRORS; i++) {
268 err_clear_data(s, i);
273 static void do_err_strings_init(void)
275 err_string_lock = CRYPTO_THREAD_lock_new();
278 void err_cleanup(void)
280 CRYPTO_THREAD_lock_free(err_string_lock);
281 err_string_lock = NULL;
284 void ERR_load_ERR_strings(void)
286 #ifndef OPENSSL_NO_ERR
287 CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
289 err_load_strings(0, ERR_str_libraries);
290 err_load_strings(0, ERR_str_reasons);
291 err_load_strings(ERR_LIB_SYS, ERR_str_functs);
292 build_SYS_str_reasons();
293 err_load_strings(ERR_LIB_SYS, SYS_str_reasons);
297 static void err_load_strings(int lib, ERR_STRING_DATA *str)
299 LHASH_OF(ERR_STRING_DATA) *hash;
301 CRYPTO_THREAD_write_lock(err_string_lock);
302 hash = get_hash(1, 0);
304 for (; str->error; str++) {
306 str->error |= ERR_PACK(lib, 0, 0);
307 (void)lh_ERR_STRING_DATA_insert(hash, str);
310 CRYPTO_THREAD_unlock(err_string_lock);
313 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
315 ERR_load_ERR_strings();
316 err_load_strings(lib, str);
319 void ERR_unload_strings(int lib, ERR_STRING_DATA *str)
321 LHASH_OF(ERR_STRING_DATA) *hash;
323 CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
325 CRYPTO_THREAD_write_lock(err_string_lock);
326 hash = get_hash(0, 0);
328 for (; str->error; str++) {
330 str->error |= ERR_PACK(lib, 0, 0);
331 (void)lh_ERR_STRING_DATA_delete(hash, str);
334 CRYPTO_THREAD_unlock(err_string_lock);
337 void err_free_strings_int(void)
339 CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
341 CRYPTO_THREAD_write_lock(err_string_lock);
342 lh_ERR_STRING_DATA_free(int_error_hash);
343 int_error_hash = NULL;
344 CRYPTO_THREAD_unlock(err_string_lock);
347 /********************************************************/
349 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
355 * In the BS2000-OSD POSIX subsystem, the compiler generates path names
356 * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
357 * something sensible. @@@ We shouldn't modify a const string, though.
359 if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
362 /* Skip the "*POSIX(" prefix */
363 file += sizeof("*POSIX(") - 1;
364 end = &file[strlen(file) - 1];
367 /* Optional: use the basename of the path only. */
368 if ((end = strrchr(file, '/')) != NULL)
372 es = ERR_get_state();
374 es->top = (es->top + 1) % ERR_NUM_ERRORS;
375 if (es->top == es->bottom)
376 es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
377 es->err_flags[es->top] = 0;
378 es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
379 es->err_file[es->top] = file;
380 es->err_line[es->top] = line;
381 err_clear_data(es, es->top);
384 void ERR_clear_error(void)
389 es = ERR_get_state();
391 for (i = 0; i < ERR_NUM_ERRORS; i++) {
394 es->top = es->bottom = 0;
397 unsigned long ERR_get_error(void)
399 return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
402 unsigned long ERR_get_error_line(const char **file, int *line)
404 return (get_error_values(1, 0, file, line, NULL, NULL));
407 unsigned long ERR_get_error_line_data(const char **file, int *line,
408 const char **data, int *flags)
410 return (get_error_values(1, 0, file, line, data, flags));
413 unsigned long ERR_peek_error(void)
415 return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
418 unsigned long ERR_peek_error_line(const char **file, int *line)
420 return (get_error_values(0, 0, file, line, NULL, NULL));
423 unsigned long ERR_peek_error_line_data(const char **file, int *line,
424 const char **data, int *flags)
426 return (get_error_values(0, 0, file, line, data, flags));
429 unsigned long ERR_peek_last_error(void)
431 return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
434 unsigned long ERR_peek_last_error_line(const char **file, int *line)
436 return (get_error_values(0, 1, file, line, NULL, NULL));
439 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
440 const char **data, int *flags)
442 return (get_error_values(0, 1, file, line, data, flags));
445 static unsigned long get_error_values(int inc, int top, const char **file,
446 int *line, const char **data,
453 es = ERR_get_state();
465 return ERR_R_INTERNAL_ERROR;
468 if (es->bottom == es->top)
471 i = es->top; /* last error */
473 i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
475 ret = es->err_buffer[i];
478 es->err_buffer[i] = 0;
481 if ((file != NULL) && (line != NULL)) {
482 if (es->err_file[i] == NULL) {
487 *file = es->err_file[i];
489 *line = es->err_line[i];
495 err_clear_data(es, i);
498 if (es->err_data[i] == NULL) {
503 *data = es->err_data[i];
505 *flags = es->err_data_flags[i];
511 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
513 char lsbuf[64], fsbuf[64], rsbuf[64];
514 const char *ls, *fs, *rs;
515 unsigned long l, f, r;
519 r = ERR_GET_REASON(e);
521 ls = ERR_lib_error_string(e);
522 fs = ERR_func_error_string(e);
523 rs = ERR_reason_error_string(e);
526 BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
528 BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
530 BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
532 BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
533 fs ? fs : fsbuf, rs ? rs : rsbuf);
534 if (strlen(buf) == len - 1) {
536 * output may be truncated; make sure we always have 5
537 * colon-separated fields, i.e. 4 colons ...
540 if (len > NUM_COLONS) { /* ... if possible */
544 for (i = 0; i < NUM_COLONS; i++) {
545 char *colon = strchr(s, ':');
546 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
548 * set colon no. i at last possible position (buf[len-1]
549 * is the terminating 0)
551 colon = &buf[len - 1] - NUM_COLONS + i;
561 * ERR_error_string_n should be used instead for ret != NULL as
562 * ERR_error_string cannot know how large the buffer is
564 char *ERR_error_string(unsigned long e, char *ret)
566 static char buf[256];
570 ERR_error_string_n(e, ret, 256);
575 LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void)
577 return get_hash(0, 1);
580 const char *ERR_lib_error_string(unsigned long e)
582 ERR_STRING_DATA d, *p;
585 CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
588 d.error = ERR_PACK(l, 0, 0);
589 p = int_err_get_item(&d);
590 return ((p == NULL) ? NULL : p->string);
593 const char *ERR_func_error_string(unsigned long e)
595 ERR_STRING_DATA d, *p;
598 CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
602 d.error = ERR_PACK(l, f, 0);
603 p = int_err_get_item(&d);
604 return ((p == NULL) ? NULL : p->string);
607 const char *ERR_reason_error_string(unsigned long e)
609 ERR_STRING_DATA d, *p = NULL;
612 CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
615 r = ERR_GET_REASON(e);
616 d.error = ERR_PACK(l, 0, r);
617 p = int_err_get_item(&d);
619 d.error = ERR_PACK(0, 0, r);
620 p = int_err_get_item(&d);
622 return ((p == NULL) ? NULL : p->string);
625 void err_delete_thread_state(void)
627 ERR_STATE *state = ERR_get_state();
631 CRYPTO_THREAD_set_local(&err_thread_local, NULL);
632 ERR_STATE_free(state);
635 #if OPENSSL_API_COMPAT < 0x10000000L
636 void ERR_remove_thread_state(void *dummy)
641 #if OPENSSL_API_COMPAT < 0x10000000L
642 void ERR_remove_state(unsigned long pid)
647 static void err_do_init(void)
649 CRYPTO_THREAD_init_local(&err_thread_local, NULL);
652 ERR_STATE *ERR_get_state(void)
654 ERR_STATE *state = NULL;
656 CRYPTO_THREAD_run_once(&err_init, err_do_init);
658 state = CRYPTO_THREAD_get_local(&err_thread_local);
661 state = OPENSSL_zalloc(sizeof(*state));
665 if (!CRYPTO_THREAD_set_local(&err_thread_local, state)) {
666 ERR_STATE_free(state);
670 /* Ignore failures from these */
671 OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
672 ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE);
678 int ERR_get_next_error_library(void)
682 CRYPTO_THREAD_run_once(&err_string_init, do_err_strings_init);
684 CRYPTO_THREAD_write_lock(err_string_lock);
685 ret = int_err_library_number++;
686 CRYPTO_THREAD_unlock(err_string_lock);
690 void ERR_set_error_data(char *data, int flags)
695 es = ERR_get_state();
699 i = ERR_NUM_ERRORS - 1;
701 err_clear_data(es, i);
702 es->err_data[i] = data;
703 es->err_data_flags[i] = flags;
706 void ERR_add_error_data(int num, ...)
710 ERR_add_error_vdata(num, args);
714 void ERR_add_error_vdata(int num, va_list args)
720 str = OPENSSL_malloc(s + 1);
726 for (i = 0; i < num; i++) {
727 a = va_arg(args, char *);
728 /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
733 p = OPENSSL_realloc(str, s + 1);
740 OPENSSL_strlcat(str, a, (size_t)s + 1);
743 ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
746 int ERR_set_mark(void)
750 es = ERR_get_state();
752 if (es->bottom == es->top)
754 es->err_flags[es->top] |= ERR_FLAG_MARK;
758 int ERR_pop_to_mark(void)
762 es = ERR_get_state();
764 while (es->bottom != es->top
765 && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
766 err_clear(es, es->top);
769 es->top = ERR_NUM_ERRORS - 1;
772 if (es->bottom == es->top)
774 es->err_flags[es->top] &= ~ERR_FLAG_MARK;